kcron/ctcron.cpp

   1 /***************************************************************************
   2  *   CT Cron Implementation                                                *
   3  *   --------------------------------------------------------------------  *
   4  *   Copyright (C) 1999, Gary Meyer <gary@meyer.net>                       *
   5  *   --------------------------------------------------------------------  *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  ***************************************************************************/
  11
  12 // Do not introduce any Qt or KDE dependencies into the "CT"-prefixed classes.
  13 // I want to be able to reuse these classes with another GUI toolkit. -GM 11/99
  14
  15 #include "ctcron.h"
  16
  17 #include "cti18n.h"
  18 #include "cttask.h"
  19 #include "ctvariable.h"
  20 #include <unistd.h>      // getuid(), unlink()
  21 #include <pwd.h>         // pwd, getpwnam(), getpwuid()
  22 #include <stdio.h>
  23 #include <assert.h>
  24
  25 #include <QFile>
  26
  27 #include <kshell.h>
  28 #include <klocale.h>
  29 #include <ktemporaryfile.h>
  30
  31 #include <iostream>
  32
  33 using namespace std;
  34
  35 CTCron::CTCron(const QString& crontabBinary, bool _syscron, string _login) :
  36   syscron(_syscron)
  37 {
  38   int uid(getuid());
  39
  40   this->crontab = crontabBinary;
  41
  42   KTemporaryFile tmp;
  43   tmp.open();
  44   tmpFileName = tmp.fileName();
  45
  46   QString readCommand;
  47
  48   if (uid == 0)
  49   // root, so provide requested crontab
  50   {
  51     if (syscron)
  52     {
  53       readCommand  = "cat /etc/crontab > " + KShell::quoteArg(tmpFileName);
  54       writeCommand = "cat " + KShell::quoteArg(tmpFileName) + " > /etc/crontab";
  55       login = (const char *)i18n("(System Crontab)").toLocal8Bit();
  56       name = "";
  57     }
  58     else
  59     {
  60       readCommand  = crontab + " -u " + _login.c_str() + " -l > " + KShell::quoteArg(tmpFileName);
  61       writeCommand = crontab + " -u " + _login.c_str() + " " + KShell::quoteArg(tmpFileName);
  62       if (!initFromPasswd(getpwnam(_login.c_str())))
  63       {
  64          error = i18n("No password entry found for user '%1'", _login.c_str());
  65       }
  66     }
  67   }
  68   else
  69   // regular user, so provide user's own crontab
  70   {
  71     readCommand  = crontab + " -l > " + KShell::quoteArg(tmpFileName);
  72     writeCommand = crontab + " "      + KShell::quoteArg(tmpFileName);
  73     if (!initFromPasswd(getpwuid(uid)))
  74     {
  75       error = i18n("No password entry found for uid '%1'", uid);
  76     }
  77   }
  78
  79   if (name.empty())
  80     name = login;
  81
  82   initialTaskCount      = 0;
  83   initialVariableCount  = 0;
  84
  85   if (isError())
  86      return;
  87
  88   // Don't set error if it can't be read, it means the user
  89   // doesn't have a crontab.
  90   if (system(QFile::encodeName(readCommand)) == 0)
  91   {
  92     ifstream cronfile(QFile::encodeName(tmpFileName));
  93     cronfile >> *this;
  94   }
  95
  96   initialTaskCount      = task.size();
  97   initialVariableCount  = variable.size();
  98 }
  99
 100 CTCron::CTCron(const QString& crontabBinary, const struct passwd *pwd) :
 101   syscron(false)
 102 {
 103   Q_ASSERT(pwd != 0L);
 104
 105   crontab = crontabBinary;
 106
 107   KTemporaryFile tmp;
 108   tmp.open();
 109   tmpFileName = tmp.fileName();
 110
 111   QString readCommand  = crontab + " -u " + QString(pwd->pw_name) + " -l > " + KShell::quoteArg(tmpFileName);
 112   writeCommand = crontab +  " -u " + QString(pwd->pw_name) + " " + KShell::quoteArg(tmpFileName);
 113
 114   initFromPasswd(pwd);
 115
 116   initialTaskCount      = 0;
 117   initialVariableCount  = 0;
 118
 119   if (isError())
 120      return;
 121
 122   // Don't set error if it can't be read, it means the user
 123   // doesn't have a crontab.
 124   if (system(QFile::encodeName(readCommand)) == 0)
 125   {
 126     ifstream cronfile(QFile::encodeName(tmpFileName));
 127     cronfile >> *this;
 128   }
 129
 130   initialTaskCount      = task.size();
 131   initialVariableCount  = variable.size();
 132 }
 133
 134 bool CTCron::initFromPasswd(const struct passwd *pwd)
 135 {
 136    if (pwd == 0)
 137    {
 138       return false;
 139    }
 140    else
 141    {
 142       login = pwd->pw_name;
 143       name = pwd->pw_gecos;
 144       return true;
 145    }
 146 }
 147
 148 void CTCron::operator = (const CTCron& source)
 149 {
 150   assert(!source.syscron);
 151
 152   for (CTVariableIterator i = const_cast<CTCron&>(source).variable.begin();
 153     i != source.variable.end(); ++i)
 154   {
 155     CTVariable* tmp = new CTVariable(**i);
 156     variable.push_back(tmp);
 157   }
 158
 159   for (CTTaskIterator i = const_cast<CTCron&>(source).task.begin();
 160     i != source.task.end(); ++i)
 161   {
 162     CTTask* tmp = new CTTask(**i);
 163     task.push_back(tmp);
 164   }
 165 }
 166
 167 istream& operator >> (istream& inputStream, CTCron& cron)
 168 {
 169   const int MAX = 1024;
 170   char buffer[MAX];
 171   string line("");
 172   string comment("");
 173
 174   while (inputStream)
 175   {
 176     inputStream.getline(buffer, MAX);
 177     line = buffer;
 178
 179     // search for comments "#" but not disabled tasks "#\"
 180     if ((line.find("#") == 0) && (line.find("\\") != 1))
 181     {
 182       // If the first 10 characters don't contain a character, it's probably a disabled entry.
 183       int first_text = line.find_first_of("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ");
 184       if (first_text < 0)
 185          continue;
 186
 187       if (first_text < 10)
 188       {
 189          // remove leading pound sign
 190          line = line.substr(1,line.length()-1);
 191          // remove leading whitespace
 192          while (line.find_first_of(" \t") == 0)
 193             line = line.substr(1,line.length()-1);
 194          comment = line;
 195          continue;
 196       }
 197     }
 198
 199     // else
 200     {
 201       // either a task or a variable
 202       int firstWhiteSpace(line.find_first_of(" \t"));
 203       int firstEquals(line.find("="));
 204
 205       // if there is an equals sign and either there is no
 206       // whitespace or the first whitespace is after the equals
 207       // sign, it must be a variable
 208       if ((firstEquals > 0) && ((firstWhiteSpace == -1) ||
 209         firstWhiteSpace > firstEquals))
 210       {
 211         // create variable
 212         CTVariable *tmp = new CTVariable(line, comment);
 213         cron.variable.push_back(tmp);
 214         comment = "";
 215       }
 216       else
 217       // must be a task, either enabled or disabled
 218       {
 219         if (firstWhiteSpace > 0)
 220         {
 221           CTTask *tmp = new CTTask(line, comment, cron.syscron);
 222           cron.task.push_back(tmp);
 223           comment = "";
 224         }
 225       }
 226     }
 227   }
 228   return inputStream;
 229 }
 230
 231 ostream& operator << (ostream& outputStream, const CTCron& cron)
 232 {
 233   int itemCount(0);
 234
 235   for (CTVariableIterator i = const_cast<CTCron&>(cron).variable.begin();
 236     i != cron.variable.end(); ++i)
 237   {
 238     outputStream << **i;
 239     itemCount++;
 240   }
 241
 242   for (CTTaskIterator i = const_cast<CTCron&>(cron).task.begin();
 243     i != cron.task.end(); ++i)
 244   {
 245     outputStream << **i;
 246     itemCount++;
 247   }
 248
 249   if (itemCount > 0)
 250   {
 251     outputStream << "# This file was written by KCron. Copyright (c) 1999, Gary Meyer\n";
 252     outputStream << "# Although KCron supports most crontab formats, use care when editing.\n";
 253     outputStream << "# Note: Lines beginning with \"#\\\" indicates a disabled task.\n";
 254   }
 255
 256   return outputStream;
 257 }
 258
 259 CTCron::~CTCron()
 260 {
 261   for (CTTaskIterator i = task.begin(); i != task.end(); ++i)
 262     delete *i;
 263   for (CTVariableIterator i = variable.begin(); i != variable.end(); ++i)
 264     delete *i;
 265 }
 266
 267 void CTCron::apply()
 268 {
 269   // write to temp file
 270   ofstream cronfile(QFile::encodeName(tmpFileName));
 271   cronfile << *this << flush;
 272
 273   // install temp file into crontab
 274   if (system(QFile::encodeName(writeCommand)) != 0)
 275   {
 276     error = i18n("An error occurred while updating crontab.");
 277   }
 278
 279   // remove the temp file
 280   (void) unlink(QFile::encodeName(tmpFileName));
 281
 282   if (isError())
 283     return;
 284
 285   // mark as applied
 286   for (CTTaskIterator i = task.begin(); i != task.end(); ++i)
 287     (*i)->apply();
 288
 289   for (CTVariableIterator i = variable.begin(); i != variable.end(); ++i)
 290     (*i)->apply();
 291
 292   initialTaskCount = task.size();
 293   initialVariableCount = variable.size();
 294 }
 295
 296 void CTCron::cancel()
 297 {
 298   for (CTTaskIterator i = task.begin(); i != task.end(); ++i)
 299     (*i)->cancel();
 300
 301   for (CTVariableIterator i = variable.begin(); i != variable.end(); ++i)
 302     (*i)->cancel();
 303 }
 304
 305 bool CTCron::dirty()
 306 {
 307   bool isDirty(false);
 308
 309   if (initialTaskCount != task.size()) isDirty = true;
 310
 311   if (initialVariableCount != variable.size()) isDirty = true;
 312
 313   for (CTTaskIterator i = task.begin(); i != task.end(); ++i)
 314     if ((*i)->dirty()) isDirty = true;
 315
 316   for (CTVariableIterator i = variable.begin(); i != variable.end(); ++i)
 317     if ((*i)->dirty()) isDirty = true;
 318
 319   return isDirty;
 320 }
 321
 322 string CTCron::path() const
 323 {
 324   string path;
 325
 326   for (CTVariableIterator var = const_cast<CTCron*>(this)->variable.begin();
 327     var != variable.end(); var++)
 328   {
 329     if ((*var)->variable == "PATH")
 330     {
 331       path = (*var)->value;
 332     }
 333   }
 334   return path;
 335 }