ktimetracker/timetrackerstorage.cpp

   1 /*
   2  *     Copyright (C) 2003, 2004 by Mark Bucciarelli <mark@hubcapconsutling.com>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation; either version 2 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License along
  15  *   with this program; if not, write to the
  16  *      Free Software Foundation, Inc.
  17  *      51 Franklin Street, Fifth Floor
  18  *      Boston, MA  02110-1301  USA.
  19  *
  20  */
  21
  22 /** timetrackerstorage
  23   * This class cares for the storage of ktimetracker's data.
  24   * ktimetracker's data is
  25   * - tasks like "programming for customer foo"
  26   * - events like "from 2009-09-07, 8pm till 10pm programming for customer foo"
  27   * tasks are like the items on your todo list, events are dates when you worked on them.
  28   * ktimetracker's data is stored in a ResourceCalendar object hold by mCalendar.
  29   */
  30
  31 #include "timetrackerstorage.h"
  32 #include "ktimetrackerutility.h"
  33 #include "ktimetracker.h"
  34 #include "storageadaptor.h"
  35 #include "task.h"
  36 #include "taskview.h"
  37 #include "timekard.h"
  38
  39 #include <kemailsettings.h>
  40 #include <kio/netaccess.h>
  41 #include <kcal/resourcecalendar.h>
  42 #include <kcal/resourcelocal.h>
  43 #include <resourceremote.h>
  44 #include <kcal/incidence.h>
  45
  46 #include <KApplication>       // kapp
  47 #include <KDebug>
  48 #include <KLocale>            // i18n
  49 #include <KMessageBox>
  50 #include <KProgressDialog>
  51 #include <KSystemTimeZones>
  52 #include <KTemporaryFile>
  53 #include <KUrl>
  54
  55 #include <QByteArray>
  56 #include <QDateTime>
  57 #include <QFile>
  58 #include <QList>
  59 #include <QMultiHash>
  60 #include <QSize>
  61 #include <QString>
  62 #include <QStringList>
  63 #include <QTableWidget>
  64 #include <QTextStream>
  65
  66 #include <sys/stat.h>
  67 #include <sys/types.h>
  68 #include <unistd.h>
  69 #include <cassert>
  70 #include <fcntl.h>
  71
  72
  73 //@cond PRIVATE
  74 class timetrackerstorage::Private
  75 {
  76 public:
  77     Private() : mCalendar( 0 ) {}
  78     ~Private()
  79     {
  80         delete mCalendar;
  81     }
  82     KCal::ResourceCalendar *mCalendar;
  83     QString mICalFile;
  84 };
  85 //@endcond
  86
  87 timetrackerstorage::timetrackerstorage() : d( new Private() )
  88 {
  89 }
  90
  91 timetrackerstorage::~timetrackerstorage()
  92 {
  93     delete d;
  94 }
  95
  96 QString timetrackerstorage::load( TaskView* view, const QString &fileName )
  97 // loads data from filename into view. If no filename is given, filename from preferences is used.
  98 // filename might be of use if this program is run as embedded konqueror plugin.
  99 {
 100     kDebug(5970) << "Entering function";
 101     QString err;
 102     KEMailSettings settings;
 103     QString lFileName = fileName;
 104
 105     assert( !( lFileName.isEmpty() ) );
 106
 107     // If same file, don't reload
 108     if ( lFileName == d->mICalFile ) return err;
 109
 110
 111     // If file doesn't exist, create a blank one to avoid ResourceLocal load
 112     // error.  We make it user and group read/write, others read.  This is
 113     // masked by the users umask.  (See man creat)
 114     if ( !( remoteResource( lFileName ) ) )
 115     {
 116         int handle;
 117         handle = open ( QFile::encodeName( lFileName ), O_CREAT | O_EXCL | O_WRONLY,
 118                S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH );
 119         if ( handle != -1 )
 120         {
 121             close( handle );
 122         }
 123     }
 124     if ( d->mCalendar )
 125         closeStorage();
 126     // Create local file resource and add to resources
 127     d->mICalFile = lFileName;
 128
 129     KCal::ResourceCached *resource;
 130     if ( remoteResource( d->mICalFile ) )
 131     {
 132         KUrl url( d->mICalFile );
 133         resource = new KCal::ResourceRemote( url, url ); // same url for upload and download
 134     }
 135     else
 136     {
 137         resource = new KCal::ResourceLocal( d->mICalFile );
 138     }
 139     d->mCalendar = resource;
 140
 141     QObject::connect (d->mCalendar, SIGNAL(resourceChanged(ResourceCalendar *)),
 142                     view, SLOT(iCalFileModified(ResourceCalendar *)));
 143     d->mCalendar->setTimeSpec( KSystemTimeZones::local() );
 144     d->mCalendar->setResourceName( QString::fromLatin1("KTimeTracker") );
 145     d->mCalendar->open();
 146     d->mCalendar->load();
 147
 148     // Claim ownership of iCalendar file if no one else has.
 149     KCal::Person owner = resource->owner();
 150     if ( owner.isEmpty() )
 151     {
 152         resource->setOwner( KCal::Person(
 153           settings.getSetting( KEMailSettings::RealName ),
 154           settings.getSetting( KEMailSettings::EmailAddress ) ) );
 155     }
 156
 157     // Build task view from iCal data
 158     if (!err.isEmpty())
 159     {
 160         KCal::Todo::List todoList;
 161         KCal::Todo::List::ConstIterator todo;
 162         QMultiHash< QString, Task* > map;
 163
 164         // Build dictionary to look up Task object from Todo uid.  Each task is a
 165         // QListViewItem, and is initially added with the view as the parent.
 166         todoList = d->mCalendar->rawTodos();
 167         kDebug(5970) << "timetrackerstorage::load"
 168             << "rawTodo count (includes completed todos) ="
 169             << todoList.count();
 170         for( todo = todoList.constBegin(); todo != todoList.constEnd(); ++todo )
 171         {
 172             Task* task = new Task(*todo, view);
 173             map.insert( (*todo)->uid(), task );
 174             view->setRootIsDecorated(true);
 175             task->setPixmapProgress();
 176         }
 177
 178         // Load each task under it's parent task.
 179         for( todo = todoList.constBegin(); todo != todoList.constEnd(); ++todo )
 180         {
 181             Task* task = map.value( (*todo)->uid() );
 182             // No relatedTo incident just means this is a top-level task.
 183             if ( (*todo)->relatedTo() )
 184             {
 185                 Task* newParent = map.value( (*todo)->relatedToUid() );
 186
 187                 // Complete the loading but return a message
 188                 if ( !newParent )
 189                     err = i18n("Error loading \"%1\": could not find parent (uid=%2)",
 190                         task->name(),
 191                 (*todo)->relatedToUid());
 192
 193             if (!err.isEmpty()) task->move( newParent );
 194             }
 195         }
 196
 197         kDebug(5970) << "timetrackerstorage::load - loaded" << view->count()
 198             << "tasks from" << d->mICalFile;
 199     }
 200
 201     if ( view ) buildTaskView(d->mCalendar, view);
 202     return err;
 203 }
 204
 205 Task* timetrackerstorage::task( const QString& uid, TaskView* view )
 206 // return the tasks with the uid uid out of view.
 207 // If !view, return the todo with the uid uid.
 208 {
 209     kDebug(5970) << "Entering function";
 210     KCal::Todo::List todoList;
 211     KCal::Todo::List::ConstIterator todo;
 212     todoList = d->mCalendar->rawTodos();
 213     todo = todoList.constBegin();
 214     Task* result=0;
 215     bool konsolemode=false;
 216     if ( view == 0 ) konsolemode=true;
 217     while ( todo != todoList.constEnd() && ( (*todo)->uid() != uid ) ) ++todo;
 218     if ( todo != todoList.constEnd() ) result = new Task((*todo), view, konsolemode);
 219     kDebug(5970) << "Leaving function, returning " << result;
 220     return result;
 221 }
 222
 223 QString timetrackerstorage::icalfile()
 224 {
 225     kDebug(5970) << "Entering function";
 226     return d->mICalFile;
 227 }
 228
 229 QString timetrackerstorage::buildTaskView(KCal::ResourceCalendar *rc, TaskView *view)
 230 // makes *view contain the tasks out of *rc.
 231 {
 232     kDebug(5970) << "Entering function";
 233     QString err;
 234     KCal::Todo::List todoList;
 235     KCal::Todo::List::ConstIterator todo;
 236     QMultiHash< QString, Task* > map;
 237     QVector<QString> runningTasks;
 238     QVector<QDateTime> startTimes;
 239
 240     // remember tasks that are running and their start times
 241     QTreeWidgetItemIterator it( view );
 242     while ( *it )
 243     {
 244         Task *task = static_cast< Task* >( *it );
 245         if ( task->isRunning() )
 246         {
 247             runningTasks.append( task->uid() );
 248             startTimes.append( task->startTime() );
 249         }
 250         ++it;
 251     }
 252
 253     view->clear();
 254     todoList = rc->rawTodos();
 255     for ( todo = todoList.constBegin(); todo != todoList.constEnd(); ++todo )
 256     {
 257         Task* task = new Task(*todo, view);
 258         task->setWhatsThis(0,i18n("The task name is what you call the task, it can be chosen freely."));
 259         task->setWhatsThis(1,i18n("The session time is the time since you last chose \"start new session.\""));
 260         map.insert( (*todo)->uid(), task );
 261         view->setRootIsDecorated(true);
 262         task->setPixmapProgress();
 263     }
 264
 265     // 1.1. Load each task under it's parent task.
 266     for( todo = todoList.constBegin(); todo != todoList.constEnd(); ++todo )
 267     {
 268         Task* task = map.value( (*todo)->uid() );
 269         // No relatedTo incident just means this is a top-level task.
 270         if ( (*todo)->relatedTo() )
 271         {
 272             Task* newParent = map.value( (*todo)->relatedToUid() );
 273             // Complete the loading but return a message
 274             if ( !newParent )
 275                 err = i18n("Error loading \"%1\": could not find parent (uid=%2)",
 276                     task->name(),
 277                     (*todo)->relatedToUid());
 278             else task->move( newParent );
 279         }
 280     }
 281
 282     view->clearActiveTasks();
 283     // restart tasks that have been running with their start times
 284     for ( int i=0; i<view->count(); i++)
 285     {
 286         for ( int n = 0; n < runningTasks.count(); ++n )
 287         {
 288             if ( runningTasks[n] == view->itemAt(i)->uid() )
 289             {
 290                 view->startTimerFor( view->itemAt(i), startTimes[n] );
 291             }
 292         }
 293     }
 294
 295     view->refresh();
 296     return err;
 297 }
 298
 299 QString timetrackerstorage::buildTaskView(TaskView *view)
 300 // makes *view contain the tasks out of mCalendar
 301 {
 302     return buildTaskView(d->mCalendar, view);
 303 }
 304
 305 void timetrackerstorage::closeStorage()
 306 {
 307     kDebug(5970) << "Entering function";
 308     if ( d->mCalendar )
 309     {
 310         d->mCalendar->close();
 311         delete d->mCalendar;
 312         d->mCalendar = 0;
 313     }
 314     kDebug(5970) << "Leaving function";
 315 }
 316
 317 KCal::Event::List timetrackerstorage::rawevents()
 318 {
 319     kDebug(5970) << "Entering function";
 320     return d->mCalendar->rawEvents();
 321 }
 322
 323 KCal::Todo::List timetrackerstorage::rawtodos()
 324 {
 325     kDebug(5970) << "Entering function";
 326     return d->mCalendar->rawTodos();
 327 }
 328
 329 bool timetrackerstorage::allEventsHaveEndTiMe(Task* task)
 330 {
 331     kDebug(5970) << "Entering function";
 332     KCal::Event::List eventList = d->mCalendar->rawEvents();
 333     for(KCal::Event::List::iterator i = eventList.begin();
 334         i != eventList.end(); ++i)
 335     {
 336         if ( (*i)->relatedToUid() == task->uid()
 337             || ( (*i)->relatedTo()
 338             && (*i)->relatedTo()->uid() == task->uid() ) )
 339         {
 340             if ( !(*i)->hasEndDate() ) return false;
 341         }
 342     }
 343     return true;
 344 }
 345
 346 bool timetrackerstorage::allEventsHaveEndTiMe()
 347 {
 348     kDebug(5970) << "Entering function";
 349     KCal::Event::List eventList = d->mCalendar->rawEvents();
 350     for(KCal::Event::List::iterator i = eventList.begin();
 351         i != eventList.end(); ++i)
 352     {
 353         if ( !(*i)->hasEndDate() ) return false;
 354     }
 355     return true;
 356 }
 357
 358 QString timetrackerstorage::deleteAllEvents()
 359 {
 360     kDebug(5970) << "Entering function";
 361     QString err;
 362     KCal::Event::List eventList = d->mCalendar->rawEvents();
 363     d->mCalendar->deleteAllEvents();
 364     return err;
 365 }
 366
 367 QString timetrackerstorage::save(TaskView* taskview)
 368 {
 369     kDebug(5970) << "Entering function";
 370     QString err;
 371
 372     QStack<KCal::Todo*> parents;
 373     if ( taskview ) // we may also be in konsole mode
 374     {
 375         for (int i = 0; i < taskview->topLevelItemCount(); ++i )
 376         {
 377             Task *task = static_cast< Task* >( taskview->topLevelItem( i ) );
 378             kDebug( 5970 ) << "write task" << task->name();
 379             err = writeTaskAsTodo( task, parents );
 380         }
 381     }
 382
 383     err=saveCalendar();
 384
 385     if ( err.isEmpty() )
 386     {
 387         kDebug(5970) << "timetrackerstorage::save : wrote tasks to" << d->mICalFile;
 388     }
 389     else
 390     {
 391         kWarning(5970) << "timetrackerstorage::save :" << err;
 392     }
 393     return err;
 394 }
 395
 396 QString timetrackerstorage::setTaskParent( Task* task, Task* parent )
 397 {
 398     kDebug(5970) << "Entering function";
 399     QString err;
 400     KCal::Todo* toDo;
 401     toDo = d->mCalendar->todo(task->uid());
 402     if (parent==0) toDo->removeRelation(toDo->relatedTo());
 403     else toDo->setRelatedTo(d->mCalendar->todo(parent->uid()));
 404     kDebug(5970) << "Leaving function";
 405     return err;
 406 }
 407
 408 QString timetrackerstorage::writeTaskAsTodo(Task* task, QStack<KCal::Todo*>& parents )
 409 {
 410     kDebug(5970) << "Entering function";
 411     QString err;
 412     KCal::Todo* todo;
 413
 414     todo = d->mCalendar->todo(task->uid());
 415     if ( !todo )
 416     {
 417         kDebug(5970) << "Could not get todo from calendar";
 418         return "Could not get todo from calendar";
 419     }
 420     task->asTodo(todo);
 421     if ( !parents.isEmpty() ) todo->setRelatedTo( parents.top() );
 422     parents.push( todo );
 423
 424     for ( int i = 0; i < task->childCount(); ++i )
 425     {
 426         Task *nextTask = static_cast< Task* >( task->child( i ) );
 427         err = writeTaskAsTodo( nextTask, parents );
 428     }
 429
 430     parents.pop();
 431     return err;
 432 }
 433
 434 bool timetrackerstorage::isEmpty()
 435 {
 436     kDebug(5970) << "Entering function";
 437     KCal::Todo::List todoList;
 438     todoList = d->mCalendar->rawTodos();
 439     return todoList.empty();
 440 }
 441
 442 //----------------------------------------------------------------------------
 443 // Routines that handle logging ktimetracker history
 444
 445
 446 QString timetrackerstorage::addTask(const Task* task, const Task* parent)
 447 {
 448     kDebug(5970) << "Entering function";
 449     KCal::Todo* todo;
 450     QString uid;
 451
 452     todo = new KCal::Todo();
 453     if ( d->mCalendar->addTodo( todo ) )
 454     {
 455         task->asTodo( todo  );
 456         if (parent)
 457             todo->setRelatedTo(d->mCalendar->todo(parent->uid()));
 458         uid = todo->uid();
 459     }
 460     else
 461     {
 462         // Most likely a lock could not be pulled, although there are other
 463         // possiblities (like a really confused resource manager).
 464         uid = "";
 465     }
 466     return uid;
 467 }
 468
 469 QStringList timetrackerstorage::taskidsfromname(QString taskname)
 470 {
 471     kDebug(5970) << "Entering function";
 472     QStringList result;
 473     KCal::Todo::List todoList = d->mCalendar->rawTodos();
 474     for(KCal::Todo::List::iterator i = todoList.begin();
 475         i != todoList.end(); ++i)
 476     {
 477         kDebug(5970) << (*i)->uid();
 478         if ( (*i)->summary() == taskname ) result << (*i)->uid();
 479     }
 480     return result;
 481 }
 482
 483 QStringList timetrackerstorage::taskNames() const
 484 {
 485     kDebug(5970) << "Entering function";
 486     QStringList result;
 487     KCal::Todo::List todoList = d->mCalendar->rawTodos();
 488     for(KCal::Todo::List::iterator i = todoList.begin();
 489         i != todoList.end(); ++i) result << (*i)->summary();
 490     return result;
 491 }
 492
 493 QString timetrackerstorage::removeEvent(QString uid)
 494 {
 495     kDebug(5970) << "Entering function";
 496     QString err=QString();
 497     KCal::Event::List eventList = d->mCalendar->rawEvents();
 498     for(KCal::Event::List::iterator i = eventList.begin();
 499         i != eventList.end(); ++i)
 500     {
 501         if ( (*i)->uid() == uid )
 502         {
 503             d->mCalendar->deleteEvent(*i);
 504         }
 505     }
 506     return err;
 507 }
 508
 509 bool timetrackerstorage::removeTask(Task* task)
 510 {
 511     kDebug(5970) << "Entering function";
 512     // delete history
 513     KCal::Event::List eventList = d->mCalendar->rawEvents();
 514     for(KCal::Event::List::iterator i = eventList.begin();
 515         i != eventList.end(); ++i)
 516     {
 517         if ( (*i)->relatedToUid() == task->uid()
 518             || ( (*i)->relatedTo()
 519             && (*i)->relatedTo()->uid() == task->uid()))
 520         {
 521             d->mCalendar->deleteEvent(*i);
 522         }
 523     }
 524
 525     // delete todo
 526     KCal::Todo *todo = d->mCalendar->todo(task->uid());
 527     d->mCalendar->deleteTodo(todo);
 528     // Save entire file
 529     saveCalendar();
 530
 531     return true;
 532 }
 533
 534 bool timetrackerstorage::removeTask(QString taskid)
 535 {
 536     kDebug(5970) << "Entering function";
 537     // delete history
 538     KCal::Event::List eventList = d->mCalendar->rawEvents();
 539     for(KCal::Event::List::iterator i = eventList.begin();
 540         i != eventList.end();
 541         ++i)
 542     {
 543         if ( (*i)->relatedToUid() == taskid
 544             || ( (*i)->relatedTo()
 545             && (*i)->relatedTo()->uid() == taskid))
 546         {
 547             d->mCalendar->deleteEvent(*i);
 548         }
 549     }
 550
 551     // delete todo
 552     KCal::Todo *todo = d->mCalendar->todo(taskid);
 553     d->mCalendar->deleteTodo(todo);
 554
 555     // Save entire file
 556     saveCalendar();
 557
 558     return true;
 559 }
 560
 561 void timetrackerstorage::addComment(const Task* task, const QString& comment)
 562 {
 563     kDebug(5970) << "Entering function";
 564     KCal::Todo* todo;
 565
 566     todo = d->mCalendar->todo(task->uid());
 567
 568     // Do this to avoid compiler warnings about comment not being used.  once we
 569     // transition to using the addComment method, we need this second param.
 570     QString s = comment;
 571
 572     // TODO: Use libkcal comments
 573     // todo->addComment(comment);
 574     // temporary
 575     todo->setDescription(task->comment());
 576
 577     saveCalendar();
 578 }
 579
 580 QString timetrackerstorage::report( TaskView *taskview, const ReportCriteria &rc )
 581 {
 582     kDebug(5970) << "Entering function";
 583     QString err;
 584     if ( rc.reportType == ReportCriteria::CSVHistoryExport )
 585     {
 586         err = exportcsvHistory( taskview, rc.from, rc.to, rc );
 587     }
 588     else // if ( rc.reportType == ReportCriteria::CSVTotalsExport )
 589     {
 590         if ( !rc.bExPortToClipBoard )
 591             err = exportcsvFile( taskview, rc );
 592         else
 593             err = taskview->clipTotals( rc );
 594     }
 595     return err;
 596 }
 597
 598
 599 //----------------------------------------------------------------------------
 600 // Routines that handle Comma-Separated Values export file format.
 601 //
 602 QString timetrackerstorage::exportcsvFile( TaskView *taskview,
 603                                     const ReportCriteria &rc )
 604 {
 605     kDebug(5970) << "Entering function";
 606     QString delim = rc.delimiter;
 607     QString dquote = rc.quote;
 608     QString double_dquote = dquote + dquote;
 609     bool to_quote = true;
 610     QString err;
 611     Task* task;
 612     int maxdepth=0;
 613     QString title = i18n("Export Progress");
 614     KProgressDialog dialog( taskview, 0, title );
 615     dialog.setAutoClose( true );
 616     dialog.setAllowCancel( true );
 617     dialog.progressBar()->setMaximum( 2 * taskview->count() );
 618
 619     // The default dialog was not displaying all the text in the title bar.
 620     int width = taskview->fontMetrics().width(title) * 3;
 621     QSize dialogsize;
 622     dialogsize.setWidth(width);
 623     dialog.setInitialSize( dialogsize );
 624
 625     if ( taskview->count() > 1 ) dialog.show();
 626     QString retval;
 627
 628     // Find max task depth
 629     int tasknr = 0;
 630     while ( tasknr < taskview->count() && !dialog.wasCancelled() )
 631     {
 632         dialog.progressBar()->setValue( dialog.progressBar()->value() + 1 );
 633         if ( tasknr % 15 == 0 ) kapp->processEvents(); // repainting is slow
 634         if ( taskview->itemAt(tasknr)->depth() > maxdepth )
 635             maxdepth = taskview->itemAt(tasknr)->depth();
 636         tasknr++;
 637     }
 638
 639     // Export to file
 640     tasknr = 0;
 641     while ( tasknr < taskview->count() && !dialog.wasCancelled() )
 642     {
 643         task = taskview->itemAt( tasknr );
 644         dialog.progressBar()->setValue( dialog.progressBar()->value() + 1 );
 645         if ( tasknr % 15 == 0 ) kapp->processEvents();
 646
 647         // indent the task in the csv-file:
 648         for ( int i=0; i < task->depth(); ++i ) retval += delim;
 649
 650         /*
 651         // CSV compliance
 652         // Surround the field with quotes if the field contains
 653         // a comma (delim) or a double quote
 654         if (task->name().contains(delim) || task->name().contains(dquote))
 655         to_quote = true;
 656         else
 657         to_quote = false;
 658         */
 659         to_quote = true;
 660
 661         if (to_quote)
 662             retval += dquote;
 663
 664         // Double quotes replaced by a pair of consecutive double quotes
 665         retval += task->name().replace( dquote, double_dquote );
 666
 667         if (to_quote)
 668             retval += dquote;
 669
 670         // maybe other tasks are more indented, so to align the columns:
 671         for ( int i = 0; i < maxdepth - task->depth(); ++i ) retval += delim;
 672
 673         retval += delim + formatTime( task->sessionTime(),
 674                                    rc.decimalMinutes )
 675                 + delim + formatTime( task->time(),
 676                                    rc.decimalMinutes )
 677                 + delim + formatTime( task->totalSessionTime(),
 678                                    rc.decimalMinutes )
 679                 + delim + formatTime( task->totalTime(),
 680                                    rc.decimalMinutes )
 681                 + '\n';
 682         tasknr++;
 683     }
 684
 685     // save, either locally or remote
 686     if ((rc.url.isLocalFile()) || (!rc.url.url().contains("/")))
 687     {
 688         QString filename=rc.url.toLocalFile();
 689         if (filename.isEmpty()) filename=rc.url.url();
 690         QFile f( filename );
 691         if( !f.open( QIODevice::WriteOnly ) )
 692         {
 693             err = i18n( "Could not open \"%1\".", filename );
 694         }
 695         if (err.length()==0)
 696         {
 697             QTextStream stream(&f);
 698             // Export to file
 699             stream << retval;
 700             f.close();
 701         }
 702     }
 703     else // use remote file
 704     {
 705         KTemporaryFile tmpFile;
 706         if ( !tmpFile.open() ) err = QString::fromLatin1( "Unable to get temporary file" );
 707         else
 708         {
 709             QTextStream stream ( &tmpFile );
 710             stream << retval;
 711             stream.flush();
 712             if (!KIO::NetAccess::upload( tmpFile.fileName(), rc.url, 0 )) err=QString::fromLatin1("Could not upload");
 713         }
 714     }
 715
 716     return err;
 717 }
 718
 719 // export history report as csv, all tasks X all dates in one block
 720 QString timetrackerstorage::exportcsvHistory ( TaskView      *taskview,
 721                                             const QDate   &from,
 722                                             const QDate   &to,
 723                                             const ReportCriteria &rc)
 724 {
 725     kDebug(5970) << "Entering function";
 726     QString delim = rc.delimiter;
 727     const QString cr = QString::fromLatin1("\n");
 728     QString err=QString::null;
 729     QString retval;
 730     Task* task;
 731
 732     QTableWidget* itab=new QTableWidget(); // hello, ABAP
 733     itab->setRowCount(taskview->count()+1);
 734     itab->setColumnCount(from.daysTo(to)+2);
 735     // parameter-plausi
 736     if ( from > to )
 737     {
 738         err = QString("'to' has to be a date later than or equal to 'from'.");
 739     }
 740     else
 741     {
 742         itab->setItem(0,0,new QTableWidgetItem("Task name"));
 743         for ( QDate mdate=from; mdate.daysTo(to)>=0; mdate=mdate.addDays(1) )
 744         {
 745             kDebug(5970) << mdate.toString();
 746             itab->setItem(0,1+from.daysTo(mdate),new QTableWidgetItem(mdate.toString()));
 747             for ( int n=0; n<taskview->count(); n++ )
 748             {
 749                 task=taskview->itemAt(n);
 750                 itab->setItem(n+1,0,new QTableWidgetItem(taskview->itemAt(n)->name()));
 751                 KCal::Event::List eventList = d->mCalendar->rawEvents();
 752                 for(KCal::Event::List::iterator i = eventList.begin();
 753                     i != eventList.end(); ++i)
 754                 {
 755                     if ( (*i)->relatedToUid() == task->uid() )
 756                     {
 757                         kDebug(5970) << "found an event for task, event=" << (*i)->uid();
 758                         // dtStart is stored like DTSTART;TZID=Europe/Berlin:20080327T231056
 759                         // dtEnd is stored like DTEND:20080327T231509Z
 760                         // we need to subtract the offset from UTC.
 761                         KDateTime startTime=(*i)->dtStart().addSecs((*i)->dtStart().utcOffset());
 762                         KDateTime endTime=(*i)->dtEnd().addSecs((*i)->dtEnd().utcOffset());
 763                         KDateTime NextMidNight=startTime;
 764                         NextMidNight.setTime(QTime ( 0,0 ));
 765                         NextMidNight=NextMidNight.addDays(1);
 766                         // LastMidNight := mdate.setTime(0:00) as it would read in a decent programming language
 767                         KDateTime LastMidNight=KDateTime::currentLocalDateTime();
 768                         LastMidNight.setDate(mdate);
 769                         LastMidNight.setTime(QTime(0,0));
 770                         int secsstartTillMidNight=startTime.secsTo(NextMidNight);
 771                         int secondsToAdd=0; // seconds that need to be added to the actual cell
 772                         if ( (startTime.date()==mdate) && ((*i)->dtEnd().date()==mdate) ) // all the event occurred today
 773                             secondsToAdd=startTime.secsTo(endTime);
 774                         if ( (startTime.date()==mdate) && (endTime.date()>mdate) ) // the event started today, but ended later
 775                             secondsToAdd=secsstartTillMidNight;
 776                         if ( (startTime.date()<mdate) && (endTime.date()==mdate) ) // the event started before today and ended today
 777                             secondsToAdd=LastMidNight.secsTo((*i)->dtEnd());
 778                         if ( (startTime.date()<mdate) && (endTime.date()>mdate) ) // the event started before today and ended after
 779                             secondsToAdd=86400;
 780                         int secondsSum=secondsToAdd;
 781                         if (itab->item(n+1,from.daysTo(mdate)+1))
 782                             secondsSum=itab->item(n+1,from.daysTo(mdate)+1)->text().toInt()+secondsToAdd;
 783                         itab->setItem(n+1,from.daysTo(mdate)+1,new QTableWidgetItem(QString::number(secondsSum)));
 784                     };
 785                 }
 786             }
 787         }
 788         // use the internal table itab to create the return value retval
 789         for ( int y=0; y<=(taskview->count()); y++ )
 790         {
 791             if (itab->item(y,0)) retval.append("\"").append(itab->item(y,0)->text().replace("\"","\"\"")).append("\"");  // task names
 792             for ( int x=1; x<=from.daysTo(to)+1; x++ )
 793             {
 794                 retval.append(rc.delimiter);
 795                 if (y>0)
 796                 {
 797                     if (itab->item(y,x))
 798                     {
 799                         kDebug(5970) << "itab->item(y,x)=" << itab->item(y,x)->text();
 800                         retval.append(formatTime( itab->item(y,x)->text().toInt()/60.0, rc.decimalMinutes ));
 801                     }
 802                 }
 803                 else // heading
 804                 {
 805                     retval.append(itab->item(y,x)->text());
 806                 }
 807             };
 808             retval.append("\n");
 809         }
 810         kDebug() << "Retval is \n" << retval;
 811     }
 812     // itab->show(); // GREAT for debugging purposes :)
 813     if (rc.bExPortToClipBoard)
 814         taskview->setClipBoardText(retval);
 815     else
 816     {
 817         // store the file locally or remote
 818         if ((rc.url.isLocalFile()) || (!rc.url.url().contains("/")))
 819         {
 820             kDebug(5970) << "storing a local file";
 821             QString filename=rc.url.toLocalFile();
 822             if (filename.isEmpty()) filename=rc.url.url();
 823             QFile f( filename );
 824             if( !f.open( QIODevice::WriteOnly ) )
 825             {
 826                 err = i18n( "Could not open \"%1\".", filename );
 827                 kDebug(5970) << "Could not open file";
 828             }
 829             kDebug() << "Err is " << err;
 830             if (err.length()==0)
 831             {
 832                 QTextStream stream(&f);
 833                 kDebug(5970) << "Writing to file: " << retval;
 834                 // Export to file
 835                 stream << retval;
 836                 f.close();
 837             }
 838         }
 839         else // use remote file
 840         {
 841             KTemporaryFile tmpFile;
 842             if ( !tmpFile.open() )
 843             {
 844                 err = QString::fromLatin1( "Unable to get temporary file" );
 845             }
 846             else
 847             {
 848                 QTextStream stream ( &tmpFile );
 849                 stream << retval;
 850                 stream.flush();
 851                 if (!KIO::NetAccess::upload( tmpFile.fileName(), rc.url, 0 )) err=QString::fromLatin1("Could not upload");
 852             }
 853         }
 854     }
 855     return err;
 856 }
 857
 858 void timetrackerstorage::startTimer( const Task* task, const KDateTime &when )
 859 {
 860     kDebug(5970) << "Entering function; when=" << when;
 861     KCal::Event* e;
 862     e = baseEvent(task);
 863     e->setDtStart(when);
 864     d->mCalendar->addEvent(e);
 865     task->taskView()->scheduleSave();
 866 }
 867
 868 void timetrackerstorage::startTimer( QString taskID )
 869 {
 870     kDebug(5970) << "Entering function";
 871     KCal::Todo::List todoList;
 872     KCal::Todo::List::ConstIterator todo;
 873     todoList = d->mCalendar->rawTodos();
 874     for( todo = todoList.constBegin(); todo != todoList.constEnd(); ++todo )
 875     {
 876         kDebug(5970) << (*todo)->uid();
 877         kDebug(5970) << taskID;
 878         if ( (*todo)->uid() == taskID )
 879         {
 880             kDebug(5970) << "adding event";
 881             KCal::Event* e;
 882             e = baseEvent((*todo));
 883             e->setDtStart(KDateTime::currentLocalDateTime());
 884             d->mCalendar->addEvent(e);
 885         }
 886     }
 887     saveCalendar();
 888 }
 889
 890 void timetrackerstorage::stopTimer( const Task* task, const QDateTime &when )
 891 {
 892     kDebug(5970) << "Entering function; when=" << when;
 893     KCal::Event::List eventList = d->mCalendar->rawEvents();
 894     for(KCal::Event::List::iterator i = eventList.begin();
 895         i != eventList.end();
 896         ++i)
 897     {
 898         if ( (*i)->relatedToUid() == task->uid() )
 899         {
 900             kDebug(5970) << "found an event for task, event=" << (*i)->uid();
 901             if (!(*i)->hasEndDate())
 902             {
 903                 kDebug(5970) << "this event has no enddate";
 904                 QString s=when.toString("yyyy-MM-ddThh:mm:ss.zzzZ"); // need the KDE standard from the ISO standard, not the QT one
 905                 KDateTime kwhen=KDateTime::fromString(s);
 906                 kDebug() << "kwhen ==" <<  kwhen;
 907                 (*i)->setDtEnd(kwhen);
 908             }
 909             else
 910             {
 911                 kDebug(5970) << "this event has an enddate";
 912                 kDebug(5970) << "end date is " << (*i)->dtEnd();
 913             }
 914         };
 915     }
 916     saveCalendar();
 917 }
 918
 919 bool timetrackerstorage::bookTime(const Task* task,
 920                            const QDateTime& startDateTime,
 921                            const long durationInSeconds)
 922 {
 923     kDebug(5970) << "Entering function";
 924     // Ignores preferences setting re: logging history.
 925     KCal::Event* e;
 926     QDateTime end;
 927     KDateTime start( startDateTime, KDateTime::Spec::LocalZone() ); //??? is LocalZone correct ???
 928
 929     e = baseEvent( task );
 930     e->setDtStart( start );
 931     e->setDtEnd( start.addSecs( durationInSeconds ) );
 932
 933     // Use a custom property to keep a record of negative durations
 934     e->setCustomProperty( KGlobal::mainComponent().componentName().toUtf8(),
 935         QByteArray("duration"),
 936         QString::number(durationInSeconds));
 937     return d->mCalendar->addEvent(e);
 938 }
 939
 940 void timetrackerstorage::changeTime(const Task* task, const long deltaSeconds)
 941 {
 942     kDebug(5970) << "Entering function; deltaSeconds=" << deltaSeconds;
 943     KCal::Event* e;
 944     QDateTime end;
 945     e = baseEvent(task);
 946
 947     // Don't use duration, as ICalFormatImpl::writeIncidence never writes a
 948     // duration, even though it looks like it's used in event.cpp.
 949     end = task->startTime();
 950     if ( deltaSeconds > 0 ) end = task->startTime().addSecs(deltaSeconds);
 951     e->setDtEnd(KDateTime(end, KDateTime::Spec::LocalZone()));
 952
 953     // Use a custom property to keep a record of negative durations
 954     e->setCustomProperty( KGlobal::mainComponent().componentName().toUtf8(),
 955         QByteArray("duration"),
 956         QString::number(deltaSeconds));
 957
 958     d->mCalendar->addEvent(e);
 959     task->taskView()->scheduleSave();
 960 }
 961
 962
 963 KCal::Event* timetrackerstorage::baseEvent(const Task * task)
 964 {
 965     kDebug(5970) << "Entering function";
 966     KCal::Event* e;
 967     QStringList categories;
 968     e = new KCal::Event;
 969     e->setSummary(task->name());
 970
 971     // Can't use setRelatedToUid()--no error, but no RelatedTo written to disk
 972     e->setRelatedTo(d->mCalendar->todo(task->uid()));
 973
 974     // Debugging: some events where not getting a related-to field written.
 975     assert(e->relatedTo()->uid() == task->uid());
 976
 977     // Have to turn this off to get datetimes in date fields.
 978     e->setAllDay(false);
 979     e->setDtStart(KDateTime(task->startTime(), KDateTime::Spec::LocalZone()));
 980
 981     // So someone can filter this mess out of their calendar display
 982     categories.append(i18n("KTimeTracker"));
 983     e->setCategories(categories);
 984
 985     return e;
 986 }
 987
 988 KCal::Event* timetrackerstorage::baseEvent(const Todo* todo)
 989 {
 990     kDebug(5970) << "Entering function";
 991     KCal::Event* e;
 992     QStringList categories;
 993
 994     e = new KCal::Event;
 995     e->setSummary(todo->summary());
 996
 997     // Can't use setRelatedToUid()--no error, but no RelatedTo written to disk
 998     e->setRelatedTo(d->mCalendar->todo(todo->uid()));
 999
1000     // Have to turn this off to get datetimes in date fields.
1001     e->setAllDay(false);
1002     e->setDtStart(KDateTime(todo->dtStart()));
1003
1004     // So someone can filter this mess out of their calendar display
1005     categories.append(i18n("KTimeTracker"));
1006     e->setCategories(categories);
1007
1008     return e;
1009 }
1010
1011 HistoryEvent::HistoryEvent( const QString &uid, const QString &name,
1012                             long duration, const KDateTime &start,
1013                             const KDateTime &stop, const QString &todoUid )
1014 {
1015     _uid = uid;
1016     _name = name;
1017     _duration = duration;
1018     _start = start;
1019     _stop = stop;
1020     _todoUid = todoUid;
1021 }
1022
1023 bool timetrackerstorage::remoteResource( const QString& file ) const
1024 {
1025     kDebug(5970) << "Entering function";
1026     QString f = file.toLower();
1027     bool rval = f.startsWith( QLatin1String("http://") ) || f.startsWith( QLatin1String("ftp://") );
1028     kDebug(5970) << "timetrackerstorage::remoteResource(" << file <<" ) returns" << rval;
1029     return rval;
1030 }
1031
1032 QString timetrackerstorage::saveCalendar()
1033 {
1034     kDebug(5970) << "Entering function";
1035     QString err;
1036     KABC::Lock *lock = d->mCalendar->lock();
1037     if ( !lock || !lock->lock() ) err=QString("Could not save. Could not lock file.");
1038     if ( d->mCalendar->save() )
1039     {
1040         lock->unlock();
1041     }
1042     else err=QString("Could not save. Could lock file.");
1043     lock->unlock();
1044     return err;
1045 }