karmstorage.h

/*
 *   This file only:
 *     Copyright (C) 2003  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 KARM_STORAGE_H
#define KARM_STORAGE_H
 
#include <tqdict.h>
#include <tqptrstack.h>
 
#include "journal.h"
#include "reportcriteria.h"
 
#include "desktoplist.h"
 
#include <calendarresources.h>
#include <vector>
#include "resourcecalendar.h"
#include <tdemacros.h>
 
class TQDateTime;
class Preferences;
class Task;
class TaskView;
class HistoryEvent;
 
class KarmStorage
{
  public:
    /*
     * Return reference to storage singleton.
     *
     * The constructors are private, so this must be used to create a
     * KarmStorage instance.
     */
    static KarmStorage *instance();
 
    /*
     * Load the list view with tasks read from iCalendar file.
     *
     * Parses iCalendar file, builds list view items in the proper
     * hierarchy, and loads them into the list view widget.
     *
     * If the file name passed in is the same as the last file name that was
     * loaded, this method does nothing.
     *
     * This method considers any of the following conditions errors:
     *
     *    @li the iCalendar file does not exist
     *    @li the iCalendar file is not readable
     *    @li the list group currently has list items
     *    @li an iCalendar todo has no related to attribute
     *    @li a todo is related to another todo which does not exist
     *
     * @param taskview     The list group used in the TaskView
     * @param preferences  The current KArm preferences.
     * @param fileName     Override preferences' filename
     *
     * @return empty string if success, error message if error.
     *
     */
    TQString load(TaskView* taskview, const Preferences* preferences, TQString fileName="" );
 
    /*
     * Return the name of the iCal file
     */
    TQString icalfile();
 
    /*
     * Build up the taskview.
     *
     * This is needed if the iCal file has been modified
     */
    TQString buildTaskView(KCal::ResourceCalendar *rc, TaskView *view);
    
    /* Close calendar and clear view.  Release lock if holding one. */
    void closeStorage(TaskView* view);
 
    /*
     * Save all tasks and their totals to an iCalendar file.
     *
     * All tasks must have an associated VTODO object already created in the
     * calendar file; that is, the task->uid() must refer to a valid VTODO in
     * the calender.
     * Delivers empty string if successful, else error msg.
     *
     * @param taskview    The list group used in the TaskView
     */
    TQString save(TaskView* taskview);
 
    TQString loadFromFlatFile(TaskView* taskview, const TQString& filename);
 
    TQString loadFromFlatFileCumulative(TaskView* taskview,
        const TQString& filename);
 
    TQString report( TaskView *taskview, const ReportCriteria &rc );
 
    void changeTime(const Task* task, const long deltaSeconds);
 
    bool bookTime(const Task* task, const TQDateTime& startDateTime, 
                  long durationInSeconds);
 
    void setName(const Task* task, const TQString& oldname) { Q_UNUSED(task); Q_UNUSED(oldname); }
 
 
    void startTimer(const Task* task) { Q_UNUSED(task); }
 
    void stopTimer(const Task* task, TQDateTime when=TQDateTime::currentDateTime());
 
    void addComment(const Task* task, const TQString& comment);
 
 
    bool removeTask(Task* task);
 
    TQString addTask(const Task* task, const Task* parent);
 
    bool isEmpty();
 
    bool isNewStorage(const Preferences* preferences) const;
 
    TQValueList<HistoryEvent> getHistory(const TQDate& from, const TQDate& to);
 
  private:
    static KarmStorage                *_instance;
    KCal::ResourceCalendar            *_calendar;
    TQString                           _icalfile;
 
    KarmStorage();
    void adjustFromLegacyFileFormat(Task* task);
    bool parseLine(TQString line, long *time, TQString *name, int *level,
        DesktopList* desktopList);
    TQString writeTaskAsTodo
      (Task* task, const int level, TQPtrStack< KCal::Todo >& parents);
    bool saveCalendar();
 
    KCal::Event* baseEvent(const Task*);
    bool remoteResource( const TQString& file ) const;
 
    TQString exportcsvFile( TaskView *taskview, const ReportCriteria &rc );
 
    TQString exportcsvHistory (
            TaskView* taskview,
            const TQDate& from,
            const TQDate& to,
            const ReportCriteria &rc
            );
 
    long printTaskHistory (
            const Task *task,
            const TQMap<TQString,long>& taskdaytotals,
            TQMap<TQString,long>& daytotals,
            const TQDate& from,
            const TQDate& to,
            const int level, 
        std::vector <TQString> &matrix,
            const ReportCriteria &rc
            );
};
 
class HistoryEvent
{
  public:
    HistoryEvent() {}
    HistoryEvent(TQString uid, TQString name, long duration,
        TQDateTime start, TQDateTime stop, TQString todoUid);
    TQString uid() {return _uid; }
    TQString name() {return _name; }
    long duration() {return _duration; }
    TQDateTime start() {return _start; }
    TQDateTime stop() { return _stop; }
    TQString todoUid() {return _todoUid; }
 
  private:
    TQString _uid;
    TQString _todoUid;
    TQString _name;
    long _duration;
    TQDateTime _start;
    TQDateTime _stop;
 
};
 
#endif // KARM_STORAGE_H