Files
GoldenCheetah/src/RideMetadata.cpp
Mark Liversedge 87ba542197 What's in a name ?
The 4 views have been shown to be confusing -- it is not clear
to new users what their purpose is, and hence how or why they
are different.

So in an effort to reduce the confusion I've renamed a few
things to be much more explicit and specific.

.. We embrace the fact we are a cycling program and use the term
   RIDES not ACTIVITIES for all files

.. HOME is confusing, renamed to TRENDS

.. the ANALYSIS view name is confusing, its all about ANALYSIS
   to renamed to RIDES

There will no doubt be areas that are not renamed properly we
can fix those when the arise.
2014-01-12 13:06:00 +00:00

1052 lines
35 KiB
C++

/*
* Copyright (c) 2010 Mark Liversedge (liversedge@gmail.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, write to the Free Software Foundation, Inc., 51
* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include "RideMetadata.h"
#include "SpecialFields.h"
#include "MainWindow.h"
#include "RideItem.h"
#include "Context.h"
#include "Athlete.h"
#include "RideSummaryWindow.h"
#include "Settings.h"
#include "Units.h"
#include <QXmlDefaultHandler>
#include <QtGui>
#include <QLineEdit>
// shorthand when looking up our ride via Q_PROPERTY
#define ourRideItem meta->property("ride").value<RideItem*>()
/*----------------------------------------------------------------------
* Master widget for Metadata Entry "on" RideSummaryWindow
*--------------------------------------------------------------------*/
RideMetadata::RideMetadata(Context *context, bool singlecolumn) :
QWidget(context->mainWindow), singlecolumn(singlecolumn), context(context)
{
_ride = _connected = NULL;
QVBoxLayout *mainLayout = new QVBoxLayout(this);
mainLayout->setSpacing(0);
mainLayout->setContentsMargins(0,0,0,0);
QPalette palette;
palette.setBrush(QPalette::Background, Qt::NoBrush);
setAutoFillBackground(false);
setPalette(palette);
// setup the tabs widget
tabs = new QTabWidget(this);
tabs->setMovable(true);
tabs->setPalette(palette);
tabs->setAutoFillBackground(false);
#ifdef WIN32
tabs->setStyleSheet("QTabWidget::pane { "
" margin: 0px,0px,0px,0px;"
" border: 0px;"
" border-top: 0px; }");
#endif
mainLayout->addWidget(tabs);
// read in metadata.xml and setup the tabs etc
qRegisterMetaType<RideItem*>("ride");
extraForm = new Form(this);
configUpdate();
// watch for config changes
connect(context, SIGNAL(configChanged()), this, SLOT(configUpdate()));
// Extra tab is expensive to update so we only update if it
// is visible. In this case we need to trigger refresh when the
// tab is selected -or- when the ride changes. Below is for tab.
connect(tabs, SIGNAL(currentChanged(int)), this, SLOT(setExtraTab()));
}
void
RideMetadata::setRideItem(RideItem *ride)
{
static QPointer<RideItem> _connected = NULL;
if (_connected) {
disconnect(_connected, SIGNAL(rideMetadataChanged()), this, SLOT(metadataChanged()));
}
_connected=_ride=ride;
if (ride) {
connect (_connected, SIGNAL(rideMetadataChanged()), this, SLOT(metadataChanged()));
setExtraTab();
metadataChanged();
}
}
void
RideMetadata::warnDateTime(QDateTime datetime)
{
if (rideItem() == NULL) return;
// see if there is a ride with this date/time already?
// Check if an existing ride has the same starttime
QChar zero = QLatin1Char('0');
QString targetnosuffix = QString ("%1_%2_%3_%4_%5_%6")
.arg(datetime.date().year(), 4, 10, zero)
.arg(datetime.date().month(), 2, 10, zero)
.arg(datetime.date().day(), 2, 10, zero)
.arg(datetime.time().hour(), 2, 10, zero)
.arg(datetime.time().minute(), 2, 10, zero)
.arg(datetime.time().second(), 2, 10, zero);
// now make a regexp for all know ride types
foreach(QString suffix, RideFileFactory::instance().suffixes()) {
QString conflict = context->athlete->home.absolutePath() + "/" + targetnosuffix + "." + suffix;
if (QFile(conflict).exists() && QFileInfo(conflict).fileName() != rideItem()->fileName) {
QMessageBox::warning(this, "Date/Time Entry", "A ride already exists with that date/time, if you do not change it then you will overwrite and lose existing data");
return; // only warn on the first conflict!
}
}
}
// the extra tab has all the fields that are in the current
// ride that are not shown on the tabs
void
RideMetadata::setExtraTab()
{
// wipe out the form & re-initialise -- special case for extras
extraForm->clear();
extraDefs.clear();
extraForm->initialise();
// no ride available...
if (!extraForm->isVisible() || !rideItem()) {
return;
}
// look for metadata not in config
QMapIterator<QString,QString> tags(rideItem()->ride()->tags());
tags.toFront();
while (tags.hasNext()) {
tags.next();
bool configured = false;
foreach (FieldDefinition x, fieldDefinitions) {
if (x.tab != "" && x.name == tags.key()) {
configured = true;
break;
}
}
// Try and guess the field type, for now we assume everything
// is a string; if its short make it a shorttext
// if it contains newlines make it a textbox
// Otherwise make it a text
//
if (!configured) {
int type;
if (tags.value().contains("\n")) type = FIELD_TEXTBOX;
else if (tags.value().length() < 30) type = FIELD_SHORTTEXT;
else type = FIELD_TEXT;
extraDefs.append(FieldDefinition("Extra", tags.key(), type, false, QStringList()));
extraForm->addField(extraDefs[extraDefs.count()-1]);
}
}
// now arrange the form - but only if we have anything to display!
if (extraForm->fields.count()) {
// arrange them
extraForm->arrange();
// fetch values
foreach(FormField *field, extraForm->fields) {
field->metadataChanged();
// since we show EVERYTHING, don't let the user edit them
// we might get more selective later?
field->widget->setEnabled(false);
}
}
}
RideItem*
RideMetadata::rideItem() const
{
return _ride;
}
void
RideMetadata::metadataChanged()
{
// loop through each tab
QMapIterator<QString, Form*> d(tabList);
d.toFront();
while (d.hasNext()) {
d.next();
foreach(FormField *field, d.value()->fields) // keep track so we can destroy
field->metadataChanged();
}
}
void
RideMetadata::configUpdate()
{
// use default font
setFont(QFont());
// read metadata.xml
QString filename = context->athlete->home.absolutePath()+"/metadata.xml";
if (!QFile(filename).exists()) filename = ":/xml/metadata.xml";
readXML(filename, keywordDefinitions, fieldDefinitions, colorfield);
// wipe existing tabs
QMapIterator<QString, Form*> d(tabList);
d.toFront();
while (d.hasNext()) {
d.next();
tabs->removeTab(tabs->indexOf(d.value()));
delete d.value();
}
tabList.clear();
// create forms and populate with fields
for(int i=0; i<fieldDefinitions.count(); i++) {
if (fieldDefinitions[i].tab == "") continue; // not to be shown!
Form *form;
QString tabName = specialTabs.displayName(fieldDefinitions[i].tab);
if ((form = tabList.value(tabName, NULL)) == NULL) {
form = new Form(this);
tabs->addTab(form, tabName);
tabList.insert(tabName, form);
}
form->addField(fieldDefinitions[i]);
}
// get forms arranged
QMapIterator<QString, Form*> i(tabList);
i.toFront();
while (i.hasNext()) {
i.next();
i.value()->arrange();
}
// add extra back
tabs->addTab(extraForm, "Extra");
// set Extra tab for current ride
setExtraTab();
// when constructing we have not registered
// the properties nor selected a ride
metadataChanged(); // re-read the values!
}
/*----------------------------------------------------------------------
* Forms (one per tab)
*--------------------------------------------------------------------*/
Form::Form(RideMetadata *meta) : meta(meta)
{
initialise();
}
Form::~Form()
{
clear();
}
void
Form::clear()
{
// wipe the fields
foreach (FormField *current, fields) {
delete current;
}
fields.clear();
// wipe away the layouts
foreach (QHBoxLayout *h, overrides) delete h;
overrides.clear();
// clear out and set back to NULL to indicate not allocated
if (grid1) { delete grid1; grid1 = NULL; }
if (grid2) { delete grid2; grid2 = NULL; }
if (vlayout1) { delete vlayout1; vlayout1 = NULL; }
if (vlayout2) { delete vlayout2; vlayout2 = NULL; }
if (hlayout) { delete hlayout; hlayout = NULL; }
if (contents) { delete contents; contents = NULL; }
}
void
Form::initialise()
{
QPalette palette;
palette.setBrush(QPalette::Background, Qt::NoBrush);
setPalette(palette);
setAutoFillBackground(false);
palette.setBrush(QPalette::Background, Qt::NoBrush);
contents = new QWidget;
contents->setPalette(palette);
contents->setAutoFillBackground(false);
QVBoxLayout *mainLayout = new QVBoxLayout(contents);
hlayout = new QHBoxLayout;
vlayout1 = vlayout2 = NULL;
grid1 = grid2 = NULL;
mainLayout->addLayout(hlayout);
//mainLayout->addStretch();
contents->setLayout(mainLayout);
setFrameStyle(QFrame::NoFrame);
setWidgetResizable(true);
setWidget(contents);
}
void
Form::addField(FieldDefinition &x)
{
FormField *p = new FormField(x, meta);
fields.append(p);
}
void
Form::arrange()
{
QGridLayout *here;
int x=0;
int y=0;
// special case -- a textbox and its the only field on the tab needs no label
// this is how the "Notes" tab is created
if (fields.count() == 1 && fields[0]->definition.type == FIELD_TEXTBOX) {
hlayout->addWidget(fields[0]->widget, 0, 0);
((QTextEdit*)(fields[0]->widget))->setFrameStyle(QFrame::NoFrame);
((QTextEdit*)(fields[0]->widget))->viewport()->setAutoFillBackground(false);
return;
} else {
vlayout1 = new QVBoxLayout;
here = grid1 = new QGridLayout;
vlayout1->addLayout(here);
vlayout1->addStretch();
hlayout->addLayout(vlayout1);
}
int rows = ceil(fields.count() / 2.0);
if (rows < 5) rows = 5; // minimum of 5 rows seems pleasing
for (int i=0; i<fields.count(); i++) {
if (y >= rows && meta->singlecolumn==false) {
x+=1;
y=0;
vlayout2 = new QVBoxLayout;
here = grid2 = new QGridLayout;
vlayout2->addLayout(here);
vlayout2->addStretch();
hlayout->addLayout(vlayout2);
}
here->setColumnStretch(0,0);
here->setColumnStretch(1,3);
Qt::Alignment labelalignment = Qt::AlignLeft|Qt::AlignTop;
Qt::Alignment alignment = Qt::AlignLeft|Qt::AlignTop;
if (fields[i]->definition.type < FIELD_SHORTTEXT) alignment = 0; // text types
here->addWidget(fields[i]->label, y, 0, labelalignment);
if (meta->sp.isMetric(fields[i]->definition.name)) {
QHBoxLayout *override = new QHBoxLayout;
overrides.append(override);
override->setContentsMargins(0,0,0,0);
override->addWidget(fields[i]->enabled);
override->addWidget(fields[i]->widget);
here->addLayout(override, y, 1, alignment);
//} else if (fields[i]->definition.type == FIELD_TEXTBOX) {
// here->addWidget(fields[i]->widget, ++y, 0, 2, 2, alignment);
// y++;
} else {
here->addWidget(fields[i]->widget, y, 1, alignment);
}
y++;
}
}
/*----------------------------------------------------------------------
* Form fields
*--------------------------------------------------------------------*/
FormField::FormField(FieldDefinition field, RideMetadata *meta) : definition(field), meta(meta), active(true)
{
QString units;
enabled = NULL;
isTime = false;
if (meta->sp.isMetric(field.name)) {
field.type = FIELD_DOUBLE; // whatever they say, we want a double!
units = meta->sp.rideMetric(field.name)->units(meta->context->athlete->useMetricUnits);
if (units != "") units = QString(" (%1)").arg(units);
}
// we need to show what units we use for weight...
if (field.name == "Weight" && field.type == FIELD_DOUBLE) {
units = meta->context->athlete->useMetricUnits ? tr(" (kg)") : tr (" (lbs)");
}
label = new QLabel(QString("%1%2").arg(meta->sp.displayName(field.name)).arg(units), this);
//label->setFont(font);
//label->setFixedHeight(18);
completer = NULL; // by default we don't have one
switch(field.type) {
case FIELD_TEXT : // text
case FIELD_SHORTTEXT : // shorttext
if (field.values.count()) {
completer = new QCompleter(field.values, this);
completer->setCaseSensitivity(Qt::CaseInsensitive);
completer->setCompletionMode(QCompleter::UnfilteredPopupCompletion);
}
widget = new QLineEdit(this);
dynamic_cast<QLineEdit*>(widget)->setCompleter(completer);
//widget->setFixedHeight(18);
connect (widget, SIGNAL(textChanged(const QString&)), this, SLOT(dataChanged()));
connect (widget, SIGNAL(editingFinished()), this, SLOT(editFinished()));
break;
case FIELD_TEXTBOX : // textbox
widget = new QTextEdit(this);
// rich text hangs 'fontd' for some users
dynamic_cast<QTextEdit*>(widget)->setAcceptRichText(false);
dynamic_cast<QTextEdit*>(widget)->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
if (field.name == "Change History") {
dynamic_cast<QTextEdit*>(widget)->setReadOnly(true);
} else {
connect (widget, SIGNAL(textChanged()), this, SLOT(editFinished()));
}
break;
case FIELD_INTEGER : // integer
widget = new QSpinBox(this);
//widget->setFixedHeight(18);
((QSpinBox*)widget)->setSingleStep(1);
((QSpinBox*)widget)->setMinimum(-99999999);
((QSpinBox*)widget)->setMaximum(99999999);
connect (widget, SIGNAL(valueChanged(int)), this, SLOT(dataChanged()));
connect (widget, SIGNAL(editingFinished()), this, SLOT(editFinished()));
break;
case FIELD_DOUBLE : // double
widget = new QDoubleSpinBox(this);
//widget->setFixedHeight(18);
((QDoubleSpinBox*)widget)->setSingleStep(0.01);
((QDoubleSpinBox*)widget)->setMaximum(999999.99);
if (meta->sp.isMetric(field.name)) {
enabled = new QCheckBox(this);
connect(enabled, SIGNAL(stateChanged(int)), this, SLOT(stateChanged(int)));
units = meta->sp.rideMetric(field.name)->units(meta->context->athlete->useMetricUnits);
if (units == "seconds") {
// we need to use a TimeEdit instead
delete widget;
widget = new QTimeEdit(this);
((QTimeEdit*)widget)->setDisplayFormat("hh:mm:ss");
connect(widget, SIGNAL(timeChanged(QTime)), this, SLOT(dataChanged()));
isTime = true;
} else {
connect (widget, SIGNAL(valueChanged(double)), this, SLOT(dataChanged()));
}
} else {
connect (widget, SIGNAL(valueChanged(double)), this, SLOT(dataChanged()));
}
connect (widget, SIGNAL(editingFinished()), this, SLOT(editFinished()));
break;
case FIELD_DATE : // date
widget = new QDateEdit(this);
//widget->setFixedHeight(18);
connect (widget, SIGNAL(dateChanged(const QDate)), this, SLOT(dataChanged()));
connect (widget, SIGNAL(editingFinished()), this, SLOT(editFinished()));
break;
case FIELD_TIME : // time
widget = new QTimeEdit(this);
//widget->setFixedHeight(18);
((QTimeEdit*)widget)->setDisplayFormat("hh:mm:ss AP");
connect (widget, SIGNAL(timeChanged(const QTime)), this, SLOT(dataChanged()));
connect (widget, SIGNAL(editingFinished()), this, SLOT(editFinished()));
break;
case FIELD_CHECKBOX : // check
widget = new QCheckBox(this);
//widget->setFixedHeight(18);
connect(widget, SIGNAL(stateChanged(int)), this, SLOT(stateChanged(int)));
break;
}
//widget->setFont(font);
//connect(main, SIGNAL(rideSelected()), this, SLOT(rideSelected()));
}
FormField::~FormField()
{
delete label;
switch (definition.type) {
case FIELD_TEXT:
case FIELD_SHORTTEXT: if (definition.name == "Keywords")
delete (QLineEdit*)widget;
if (completer) delete completer;
break;
case FIELD_TEXTBOX : if (definition.name == "Summary")
delete ((RideSummaryWindow *)widget);
else
delete ((QTextEdit*)widget);
break;
case FIELD_INTEGER : delete ((QSpinBox*)widget); break;
case FIELD_DOUBLE : {
if (!isTime) delete ((QDoubleSpinBox*)widget);
else delete ((QTimeEdit*)widget);
}
break;
case FIELD_DATE : delete ((QDateEdit*)widget); break;
case FIELD_TIME : delete ((QTimeEdit*)widget); break;
case FIELD_CHECKBOX : delete ((QCheckBox*)widget); break;
}
if (enabled) delete enabled;
}
void
FormField::dataChanged()
{
if (active) return;
edited = true;
}
void
FormField::editFinished()
{
if (active || ourRideItem == NULL ||
(edited == false && definition.type != FIELD_TEXTBOX) ||
ourRideItem == NULL) return;
// get values from the widgets
QString text;
// get the current value into a string
switch (definition.type) {
case FIELD_TEXT :
case FIELD_SHORTTEXT :
text = ((QLineEdit*)widget)->text();
// we specified a value list and ignored it...
if (text != "" && definition.values.count() && definition.values.indexOf(text) == -1) {
// just warn? - does nothing for now, in case they are just "suggestions"
QMessageBox::warning(this, definition.name, tr("You entered '%1' which is not an expected value.").arg(text));
}
break;
case FIELD_TEXTBOX :
{
text = ((QTextEdit*)widget)->document()->toPlainText();
break;
}
case FIELD_INTEGER : text = QString("%1").arg(((QSpinBox*)widget)->value()); break;
case FIELD_DOUBLE : {
if (!isTime) text = QString("%1").arg(((QDoubleSpinBox*)widget)->value());
else {
text = QString("%1").arg(QTime(0,0,0,0).secsTo(((QTimeEdit*)widget)->time()));
}
}
break;
case FIELD_DATE : text = ((QDateEdit*)widget)->date().toString("dd.MM.yyyy"); break;
case FIELD_TIME : text = ((QTimeEdit*)widget)->time().toString("hh:mm:ss.zzz"); break;
}
// Update special field
if (definition.name == "Device") {
ourRideItem->ride()->setDeviceType(text);
ourRideItem->notifyRideMetadataChanged();
} else if (definition.name == "Identifier") {
ourRideItem->ride()->setId(text);
ourRideItem->notifyRideMetadataChanged();
} else if (definition.name == "Recording Interval") {
ourRideItem->ride()->setRecIntSecs(text.toDouble());
ourRideItem->notifyRideMetadataChanged();
} else if (definition.name == "Start Date") {
QDateTime current = ourRideItem->ride()->startTime();
QDate date(/* year*/text.mid(6,4).toInt(),
/* month */text.mid(3,2).toInt(),
/* day */text.mid(0,2).toInt());
QDateTime update = QDateTime(date, current.time());
ourRideItem->setStartTime(update);
ourRideItem->notifyRideMetadataChanged();
// warn if the ride already exists with that date/time
meta->warnDateTime(update);
} else if (definition.name == "Start Time") {
QDateTime current = ourRideItem->ride()->startTime();
QTime time(/* hours*/ text.mid(0,2).toInt(),
/* minutes */ text.mid(3,2).toInt(),
/* seconds */ text.mid(6,2).toInt(),
/* milliseconds */ text.mid(9,3).toInt());
QDateTime update = QDateTime(current.date(), time);
ourRideItem->setStartTime(update);
ourRideItem->notifyRideMetadataChanged();
// warn if the ride already exists with that date/time
meta->warnDateTime(update);
} else if (definition.name != "Summary") {
if (meta->sp.isMetric(definition.name) && enabled->isChecked()) {
// convert from imperial to metric if needed
if (!meta->context->athlete->useMetricUnits) {
double value = text.toDouble() * (1/ meta->sp.rideMetric(definition.name)->conversion());
value -= meta->sp.rideMetric(definition.name)->conversionSum();
text = QString("%1").arg(value);
}
// update metric override QMap!
QMap<QString,QString> override;
override.insert("value", text);
ourRideItem->ride()->metricOverrides.insert(meta->sp.metricSymbol(definition.name), override);
// get widgets updated with new override
ourRideItem->notifyRideMetadataChanged();
} else {
// we need to convert from display value to
// stored value for the Weight field:
if (definition.type == FIELD_DOUBLE && definition.name == "Weight" && meta->context->athlete->useMetricUnits == false) {
double kg = text.toDouble() / LB_PER_KG;
text = QString("%1").arg(kg);
}
// just update the tags QMap!
ourRideItem->ride()->setTag(definition.name, text);
}
}
// Construct the summary text used on the calendar
QString calendarText;
foreach (FieldDefinition field, meta->getFields()) {
if (field.diary == true) {
calendarText += QString("%1\n")
.arg(ourRideItem->ride()->getTag(field.name, ""));
}
}
ourRideItem->ride()->setTag("Calendar Text", calendarText);
// rideFile is now dirty!
ourRideItem->setDirty(true);
}
void
FormField::stateChanged(int state)
{
if (active || ourRideItem == NULL) return; // being updated programmatically
// are we a checkbox -- do the simple stuff
if (definition.type == FIELD_CHECKBOX) {
ourRideItem->ride()->setTag(definition.name, ((QCheckBox *)widget)->isChecked() ? "1" : "0");
ourRideItem->setDirty(true);
return;
}
widget->setEnabled(state ? true : false);
widget->setHidden(state ? false : true);
// remove from overrides if neccessary
QMap<QString,QString> override;
if (ourRideItem && ourRideItem->ride())
override = ourRideItem->ride()->metricOverrides.value
(meta->sp.metricSymbol(definition.name));
// setup initial override value
if (state) {
// clear and reset override value for this metric
override.insert("value", QString("%1").arg(0.0)); // add metric value
if (isTime) ((QTimeEdit*)widget)->setTime(QTime(0,0,0,0));
else ((QDoubleSpinBox *)widget)->setValue(0.0);
} else if (override.contains("value")) // clear override value
override.remove("value");
if (ourRideItem && ourRideItem->ride()) {
// update overrides for this metric in the main QMap
ourRideItem->ride()->metricOverrides.insert(meta->sp.metricSymbol(definition.name), override);
// rideFile is now dirty!
ourRideItem->setDirty(true);
// get refresh done, coz overrides state has changed
ourRideItem->notifyRideMetadataChanged();
}
}
void
FormField::metadataChanged()
{
active = true;
edited = false;
QString value;
if (ourRideItem && ourRideItem->ride()) {
// Handle "Special" fields
if (definition.name == "Device") value = ourRideItem->ride()->deviceType();
else if (definition.name == "Recording Interval") value = QString("%1").arg(ourRideItem->ride()->recIntSecs());
else if (definition.name == "Start Date") value = ourRideItem->ride()->startTime().date().toString("dd.MM.yyyy");
else if (definition.name == "Start Time") value = ourRideItem->ride()->startTime().time().toString("hh:mm:ss.zzz");
else if (definition.name == "Identifier") value = ourRideItem->ride()->id();
else {
if (meta->sp.isMetric(definition.name)) {
// get from metric overrides
const QMap<QString,QString> override =
ourRideItem->ride()->metricOverrides.value(meta->sp.metricSymbol(definition.name));
if (override.contains("value")) {
enabled->setChecked(true);
widget->setEnabled(true);
widget->setHidden(false);
value = override.value("value");
// does it need conversion from metric?
if (meta->sp.rideMetric(definition.name)->conversion() != 1.0) {
// do we want imperial?
if (!meta->context->athlete->useMetricUnits) {
double newvalue = value.toDouble() * meta->sp.rideMetric(definition.name)->conversion();
newvalue -= meta->sp.rideMetric(definition.name)->conversionSum();
value = QString("%1").arg(newvalue);
}
}
} else {
value = "0.0";
enabled->setChecked(false);
widget->setEnabled(false);
widget->setHidden(true);
}
} else {
value = ourRideItem->ride()->getTag(definition.name, "");
}
}
} else {
value ="";
}
switch (definition.type) {
case FIELD_TEXT : // text
case FIELD_SHORTTEXT : // shorttext
((QLineEdit*)widget)->setText(value);
break;
case FIELD_TEXTBOX : // textbox
if (definition.name != "Summary")
((QTextEdit*)widget)->setText(value);
break;
case FIELD_INTEGER : // integer
((QSpinBox*)widget)->setValue(value.toInt());
break;
case FIELD_DOUBLE : // double
if (isTime) ((QTimeEdit*)widget)->setTime(QTime(0,0,0,0).addSecs(value.toDouble()));
else {
if (definition.name == "Weight" && meta->context->athlete->useMetricUnits == false) {
double lbs = value.toDouble() * LB_PER_KG;
value = QString("%1").arg(lbs);
}
((QDoubleSpinBox*)widget)->setValue(value.toDouble());
}
break;
case FIELD_DATE : // date
{
if (value == "") value = " ";
QDate date(/* year*/value.mid(6,4).toInt(),
/* month */value.mid(3,2).toInt(),
/* day */value.mid(0,2).toInt());
((QDateEdit*)widget)->setDate(date);
}
break;
case FIELD_TIME : // time
{
if (value == "") value = " ";
QTime time(/* hours*/ value.mid(0,2).toInt(),
/* minutes */ value.mid(3,2).toInt(),
/* seconds */ value.mid(6,2).toInt(),
/* milliseconds */ value.mid(9,3).toInt());
((QTimeEdit*)widget)->setTime(time);
}
break;
case FIELD_CHECKBOX : // checkbox
{
((QCheckBox*)widget)->setChecked((value == "1") ? true : false);
}
break;
}
active = false;
}
/*----------------------------------------------------------------------
* Read / Write metadata.xml file
*--------------------------------------------------------------------*/
// static helper to protect special xml characters
// ideally we would use XMLwriter to do this but
// the file format is trivial and this implementation
// is easier to follow and modify... for now.
static QString xmlprotect(QString string)
{
QString s = string;
s.replace( QChar( 0x2122), "&#8482;" );
s.replace( "&", "&amp;" );
s.replace( ">", "&gt;" );
s.replace( "<", "&lt;" );
s.replace( "\"", "&quot;" );
s.replace( "\'", "&apos;" );
return s;
}
void
RideMetadata::serialize(QString filename, QList<KeywordDefinition>keywordDefinitions, QList<FieldDefinition>fieldDefinitions, QString colorfield)
{
// open file - truncate contents
QFile file(filename);
file.open(QFile::WriteOnly);
file.resize(0);
QTextStream out(&file);
out.setCodec("UTF-8");
// begin document
out << "<metadata>\n";
out << QString("<colorfield>\"%1\"</colorfield>").arg(xmlprotect(colorfield));
//
// First we write out the keywords
//
out << "\t<keywords>\n";
// write out to file
foreach (KeywordDefinition keyword, keywordDefinitions) {
// chart name
out<<QString("\t\t<keyword>\n");
out<<QString("\t\t\t<keywordname>\"%1\"</keywordname>\n").arg(xmlprotect(keyword.name));
out<<QString("\t\t\t<keywordcolor red=\"%1\" green=\"%3\" blue=\"%4\"></keywordcolor>\n")
.arg(keyword.color.red())
.arg(keyword.color.green())
.arg(keyword.color.blue());
foreach (QString token, keyword.tokens)
out<<QString("\t\t\t<keywordtoken>\"%1\"</keywordtoken>\n").arg(xmlprotect(token));
out<<QString("\t\t</keyword>\n");
}
out <<"\t</keywords>\n";
//
// Last we write out the field definitions
//
out << "\t<fields>\n";
// write out to file
foreach (FieldDefinition field, fieldDefinitions) {
// chart name
out<<QString("\t\t<field>\n");
out<<QString("\t\t\t<fieldtab>\"%1\"</fieldtab>\n").arg(xmlprotect(field.tab));
out<<QString("\t\t\t<fieldname>\"%1\"</fieldname>\n").arg(xmlprotect(field.name));
out<<QString("\t\t\t<fieldtype>%1</fieldtype>\n").arg(field.type);
out<<QString("\t\t\t<fieldvalues>\"%1\"</fieldvalues>\n").arg(xmlprotect(field.values.join(",")));
out<<QString("\t\t\t<fielddiary>%1</fielddiary>\n").arg(field.diary ? 1 : 0);
out<<QString("\t\t</field>\n");
}
out <<"\t</fields>\n";
// end document
out << "</metadata>\n";
// close file
file.close();
}
static QString unprotect(QString buffer)
{
// remove quotes
QString t = buffer.trimmed();
QString s = t.mid(1,t.length()-2);
// replace html (TM) with local TM character
s.replace( "&#8482;", QChar( 0x2122) );
// html special chars are automatically handled
// other special characters will not work
// cross-platform but will work locally, so not a biggie
// i.e. if thedefault charts.xml has a special character
// in it it should be added here
return s;
}
void
RideMetadata::readXML(QString filename, QList<KeywordDefinition>&keywordDefinitions, QList<FieldDefinition>&fieldDefinitions, QString &colorfield)
{
QFile metadataFile(filename);
QXmlInputSource source( &metadataFile );
QXmlSimpleReader xmlReader;
MetadataXMLParser handler;
xmlReader.setContentHandler(&handler);
xmlReader.setErrorHandler(&handler);
xmlReader.parse( source );
keywordDefinitions = handler.getKeywords();
fieldDefinitions = handler.getFields();
colorfield = handler.getColorField();
// backwards compatible
if (colorfield == "") colorfield = "Calendar Text";
// now auto append special fields, in case
// the user wiped them or we have introduced
// them in this release. This is to ensure
// they get written to metricDB
bool hasCalendarText = false;
bool hasData = false;
foreach (FieldDefinition field, fieldDefinitions) {
if (field.name == "Data") {
hasData = true;
}
if (field.name == "Calendar Text") {
hasCalendarText = true;
}
// other fields here...
}
if (!hasCalendarText) {
FieldDefinition add;
add.name = "Calendar Text";
add.type = 1;
add.diary = false;
add.tab = "";
fieldDefinitions.append(add);
}
if (!hasData) {
FieldDefinition add;
add.name = "Data";
add.type = 2;
add.diary = false;
add.tab = "";
fieldDefinitions.append(add);
}
}
// to see the format of the charts.xml file, look at the serialize()
// function at the bottom of this source file.
bool MetadataXMLParser::endElement( const QString&, const QString&, const QString &qName)
{
//
// Single Attribute elements
//
if(qName == "keywordname") keyword.name = unprotect(buffer);
else if(qName == "keywordtoken") keyword.tokens << unprotect(buffer);
else if(qName == "keywordcolor") {
// the r,g,b values are in red="xx",green="xx" and blue="xx" attributes
// of this element and captured in startelement below
keyword.color = QColor(red,green,blue);
}
else if(qName == "fieldtab") field.tab = unprotect(buffer);
else if(qName == "fieldname") field.name = unprotect(buffer);
else if(qName == "fieldtype") {
field.type = buffer.trimmed().toInt();
if (field.tab != "" && field.type < 3 && field.name != "Filename" &&
field.name != "Change History") field.diary = true; // default!
} else if(qName == "fieldvalues") {
field.values = unprotect(buffer).split(",", QString::SkipEmptyParts);
} else if (qName == "fielddiary") field.diary = (buffer.trimmed().toInt() != 0);
//
// Complex Elements
//
else if(qName == "keyword") // <keyword></keyword> block
keywordDefinitions.append(keyword);
else if (qName == "field") // <field></field> block
fieldDefinitions.append(field);
else if (qName == "colorfield")
colorfield = unprotect(buffer);
return true;
}
bool MetadataXMLParser::startElement( const QString&, const QString&, const QString &name, const QXmlAttributes &attrs )
{
buffer.clear();
if(name == "keywords")
keywordDefinitions.clear();
else if (name == "fields")
fieldDefinitions.clear();
else if (name == "field")
field = FieldDefinition();
else if (name == "keyword")
keyword = KeywordDefinition();
else if (name == "keywordcolor") {
// red="x" green="x" blue="x" attributes for pen/brush color
for(int i=0; i<attrs.count(); i++) {
if (attrs.qName(i) == "red") red=attrs.value(i).toInt();
if (attrs.qName(i) == "green") green=attrs.value(i).toInt();
if (attrs.qName(i) == "blue") blue=attrs.value(i).toInt();
}
}
return true;
}
bool MetadataXMLParser::characters( const QString& str )
{
buffer += str;
return true;
}
bool MetadataXMLParser::endDocument()
{
return true;
}