timetrackerstorage.h

Go to the documentation of this file.

/*
 *     Copyright (C) 2003 by Mark Bucciarelli <mark@hubcapconsutling.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.
 *
 */

#ifndef KTIMETRACKER_STORAGE_H
#define KTIMETRACKER_STORAGE_H

#include <QList>
#include <QStack>
#include <QVector>

#include "reportcriteria.h"
#include "desktoplist.h"
#include "kttcalendar.h"

#include <KCalCore/Todo>
#include <KCalCore/Event>

class QDateTime;
class Task;
class TaskView;
class HistoryEvent;

class timetrackerstorage : public QObject
{
  Q_OBJECT

  public:
    timetrackerstorage();
    ~timetrackerstorage();

    QString setTaskParent( Task* task, Task* parent);

    QString load( TaskView* taskview, const QString &fileName );

    QString icalfile();

    QString buildTaskView( const KTimeTracker::KTTCalendar::Ptr &calendar, TaskView *view );

    QString buildTaskView(TaskView *view);

    void closeStorage();

    KCalCore::Event::List rawevents();

    KCalCore::Todo::List rawtodos();

    QString removeEvent(QString uid);

    KTimeTracker::KTTCalendar::Ptr calendar() const;

    bool allEventsHaveEndTiMe(Task* task);

    bool allEventsHaveEndTiMe();

    QString deleteAllEvents();

    QString save(TaskView* taskview);

    QString report( TaskView *taskview, const ReportCriteria &rc );

    void changeTime(const Task* task, const long deltaSeconds);

    void setName(const Task* task, const QString& oldname) { Q_UNUSED(task); Q_UNUSED(oldname); }


    void startTimer(const Task* task, const KDateTime &when=KDateTime::currentLocalDateTime());

    void startTimer( QString taskID );

    void stopTimer( const Task* task, const QDateTime &when = QDateTime::currentDateTime() );

    void addComment(const Task* task, const QString& comment);


    bool removeTask(Task* task);

    bool removeTask(QString taskid);

    QString addTask(const Task* task, const Task* parent=0);

    bool isEmpty();

    QStringList taskidsfromname(QString taskname);

    Task* task( const QString& uid, TaskView* view );

    QStringList taskNames() const;

  private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
    KTimeTracker::KTTCalendar::Ptr _calendar;
    QString _icalfile;

    void adjustFromLegacyFileFormat(Task* task);
    bool parseLine(QString line, long *time, QString *name, int *level,
        DesktopList* desktopList);
    QString writeTaskAsTodo( Task* task, QStack<KCalCore::Todo::Ptr>& parents );
    QString saveCalendar();

    KCalCore::Event::Ptr baseEvent(const Task*);
    KCalCore::Event::Ptr baseEvent(const KCalCore::Todo::Ptr &);
    bool isRemoteFile( const QString &file ) const;

    QString exportcsvFile( TaskView *taskview, const ReportCriteria &rc );

    QString exportcsvHistory
    (
            TaskView* taskview,
            const QDate& from,
            const QDate& to,
            const ReportCriteria &rc
    );
};

class HistoryEvent
{
  public:
    HistoryEvent() {}
    HistoryEvent( const QString &uid, const QString &name, long duration,
                  const KDateTime &start, const KDateTime &stop,
                  const QString &todoUid );
    QString uid() { return _uid; }
    QString name() { return _name; }
    long duration() { return _duration; }
    KDateTime start() { return _start; }
    KDateTime stop() { return _stop; }
    QString todoUid() { return _todoUid; }

  private:
    QString _uid;
    QString _todoUid;
    QString _name;
    long _duration;
    KDateTime _start;
    KDateTime _stop;

};

#endif // KTIMETRACKER_STORAGE_H