[svn-upgrade] Integrating new upstream version, teleschorsch (0.1.4)
[debian/teleschorsch.git] / main.cpp
1 /*
2 # Copyright and License:
3 #
4 # Copyright (C) 2007 
5 # gregor herrmann <gregor+debian@comodo.priv.at>,
6 # Philipp Spitzer <philipp@spitzer.priv.at>
7 #
8 # This program is free software; you can redistribute it and/or modify it   
9 # under the terms of the GNU General Public License version 2 as published
10 # by the Free Software Foundation.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA, or point
18 # your browser to http://www.gnu.org/licenses/gpl.html
19 */
20
21 #include <QtGlobal>
22 #include <QtDebug>
23 #include <QApplication>
24 #include <QVector>
25 #include <QFile>
26 #include <QProcess>
27 #include <QMessageBox>
28 #include <QDateTime>
29 #include <QLocale>
30 #include <QTranslator>
31 #include "main.h"
32 #include "options.h"
33
34
35 // Functions
36 // =========
37
38 void initConfigInfo(ConfigInfo& configInfo) {
39         QStringList environment = QProcess::systemEnvironment().filter(QRegExp("^HOME=")); // ("HOME=/home/gregoa")
40         if (environment.size() == 1) {
41                 configInfo.home = environment.at(0).mid(5);
42                 configInfo.userConfigFile = configInfo.home + + "/.teleschorschrc";
43         }
44         configInfo.systemConfigFile = "/etc/teleschorschrc";
45
46         // User config file
47         if (!configInfo.userConfigFile.isEmpty()) {
48                 QFile configFileUser(configInfo.userConfigFile);
49                 if (configFileUser.exists()) {configInfo.usedConfigFile  = configInfo.userConfigFile;}
50         }
51
52         // System config file
53         if (configInfo.usedConfigFile.isEmpty()) {
54                 QFile configFileSystem(configInfo.systemConfigFile);
55                 if (configFileSystem.exists()) configInfo.usedConfigFile = configInfo.systemConfigFile;
56         }
57 }
58
59
60 bool addConfig(const QString& fileName, ChannelVec& cv, QString& error) {
61         QFile file(fileName);
62         if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {error = QObject::tr("Could not open file %1").arg(fileName); return false;}
63         Channel channel; // current channel
64         bool sectionOccured = false;
65         while (!file.atEnd()) {
66                 QString line = QString(file.readLine()).trimmed();
67                 if (line.startsWith("#") || line.startsWith(";") || line.isEmpty()) continue; // strip comments
68                 
69                 // Is the line a [section]?
70                 bool section = line.startsWith("[") && line.endsWith("]") && line.size() >= 3;
71                 if (section) {
72                         if (sectionOccured) cv.push_back(channel);
73                         sectionOccured = true;
74                         channel = Channel();
75                         channel.name = line.mid(1, line.size()-2);
76                 }
77
78                 // Read properties
79                 int eqPos = line.indexOf("=");
80                 bool property = !section && eqPos >= 1;
81                 if (property) {
82                         QString propKey = line.left(eqPos);
83                         QString propVal = line.right(line.size()-eqPos-1);
84                         if (!sectionOccured) {error = QObject::tr("Property %1 is only allowed in a [section].").arg(propKey); return false;}
85
86                         if (propKey == "FULLNAME") channel.fullName = propVal;
87                         else if (propKey == "STATICURL") channel.staticUrl = propVal;
88                         else if (propKey == "PLAYER") channel.player = propVal;
89                         else {error = QObject::tr("Unknown key in ini file: %1").arg(propKey); return false;}
90                 }
91
92                 if (!section && !property) {error = QObject::tr("Line %1 is not valid.").arg(line); return false;}
93         }
94         if (sectionOccured) cv.push_back(channel);
95         return true;
96 }
97
98
99 QString readChannelVec(const ConfigInfo& configInfo, ChannelVec& channelVec) {
100         if (configInfo.usedConfigFile.isEmpty()) return QObject::tr("Neither %1 nor %2 found.").arg(configInfo.systemConfigFile).arg(configInfo.userConfigFile);
101         QString error;
102         if (!addConfig(configInfo.usedConfigFile, channelVec, error));
103         return error;
104 }
105
106
107 /// \brief Finds a value for a specified variable and appends it to a string.
108 ///
109 /// \param[in]  var    variable to substitute. These are the possibilities:
110 ///                    - d  day of month (01-31)
111 ///                    - m  month (01-12)
112 ///                    - y  year (last two digits)
113 ///                    - Y  year (4 digits)
114 ///                    - dow_DE  day of week in German (Montag, ...)
115 /// \param[in]  date   date that should be used when replacing the date dependend variables
116 /// \param[out] result The determined value of the variable is _appended_.
117 /// \param[out] error  error message in error cases
118 /// \returns true in case of success.
119 bool substituteVar(const QString& var, QDate date, QString& result, QString& errorMsg) {
120         if (var == "d") {result += date.toString("dd"); return true;}
121         if (var == "m") {result += date.toString("MM"); return true;}
122         if (var == "y") {result += date.toString("yy"); return true;}
123         if (var == "Y") {result += date.toString("yyyy"); return true;}
124         if (var == "dow_DE") {
125                 int dow = date.dayOfWeek() - 1;
126                 static const char dow_de[][16] = {"Montag", "Dienstag", "Mittwoch", "Donnerstag", "Freitag", "Samstag", "Sonntag"};
127                 if (dow >= 0 && dow < 7) {result += dow_de[dow]; return true;}
128         }
129         errorMsg = QObject::tr("No match for variable %1").arg(var);
130         return false;
131 }
132
133
134 /// \brief Finds a string, where variables of the form <code>${var}</code> are substituted in input (normally a staticUrl).
135 ///
136 /// - ${d}  day of month (01-31)
137 /// - ${m}  month (01-12)
138 /// - ${y}  year (last two digits)
139 /// - ${Y}  year (4 digits)
140 /// - ${dow_DE}  day of week in German (Montag, ...)
141 ///
142 /// \param[in]  input  string where the substitution should be done.
143 /// \param[in]  date   date that should be used when replacing the date dependend variables
144 /// \param[out] result The result string with the variables substituted is appended here
145 /// \param[out] error  error message in error cases
146 /// \returns true in case of success.
147 bool substituteVars(const QString& input, QDate date, QString& result, QString& errorMsg) {
148         int pos = 0;
149         int lastPos = 0;
150         while (pos != -1) {
151                 pos = input.indexOf("${", lastPos);
152                 if (pos == -1) result += input.mid(lastPos);
153                 else result += input.mid(lastPos, pos-lastPos);
154                 lastPos = pos;
155                 
156                 // Match?
157                 if (pos != -1) {
158                         pos = input.indexOf("}", lastPos);
159                         if (pos == -1) {
160                                 errorMsg = QObject::tr("${ not closed with }.");
161                                 return false;
162                         }
163                         QString var = input.mid(lastPos+2, pos-lastPos-2);
164                         if (!substituteVar(var, date, result, errorMsg)) return false;
165                         lastPos = pos+1;
166                 }
167         }
168         return true;
169 }
170
171
172 /// \brief Calls the /bin/sh shell with the specified command and appends the result to a string variable.
173 ///
174 /// \param[in]  command command to execute with <code>/bin/sh -c "command"</code>
175 /// \param[out] result  The result string where the output is appended at.
176 /// \param[out] error   error message in error cases
177 /// \returns true in case of success.
178 bool executeShellCommand(const QString& command, QString& result, QString& errorMsg) {
179         QProcess evalUrl(0);
180         QString cmd = "/bin/sh -c \"" + command + "\"";
181         evalUrl.start(cmd);
182         if (evalUrl.waitForFinished(3000)) {
183                 QByteArray newResult = evalUrl.readAllStandardOutput();
184                 if (result != newResult) {result += newResult.trimmed();}
185                 return true;
186         } 
187         errorMsg = QObject::tr("Shell command executed when substituting URL (%1) timed out.").arg(command);
188         return false;
189 }
190
191
192 /// \brief Evaluates the staticUrl
193 ///
194 /// - Variables of the form ${var} are substituted according the the function ::substituteVars
195 /// - If the staticUrl is enclosed by backticks it is evaluated by a shell command (after the substitution mentioned above)
196 ///
197 /// \param[in]  staticUrl string where the substitution should be done.
198 /// \param[in]  date      date that should be used when replacing the date dependend variables
199 /// \param[out] result    The result string is appended here
200 /// \param[out] error     error message in error cases
201 /// \returns true in case of success.
202 bool evaluateStaticUrl(const QString& staticUrl, QDate date, QString& result, QString& errorMsg) {
203         QString subst;
204         bool success = substituteVars(staticUrl, date, subst, errorMsg);
205         if (!success) return false;
206
207         // Evaluate staticUrl - it might be dynamic despite its name :-)
208         QString cmdres;
209         if (subst.left(1) == "`" && subst.right(1) == "`") {
210                 success = executeShellCommand(subst.mid(1, subst.size()-2), cmdres, errorMsg);
211                 if (!success) return false;
212                 result = cmdres;
213         } else result = subst;
214         return true;
215 }
216
217
218 void appendPlayerOffsetOption(const QString& player, QTime offset, QStringList& arguments) {
219         QTime zero = QTime(0, 0, 0, 0);
220         int offsetSec = zero.secsTo(offset);
221         if (player.indexOf("vlc") != -1) arguments.append("--start-time");
222         if (player.indexOf("gmplayer") != -1) {
223                 arguments << "-cache" << "512"; // -cache 512 does not belong to this function but for now...
224                 arguments << "-ss"; 
225         }
226         arguments << QString::number(offsetSec);
227 }
228
229
230
231 // MainDialog
232 // ==========
233
234 MainDialog::MainDialog(QWidget *parent): QDialog(parent) {
235         // User interface
236         setupUi(this);
237         QObject::connect(btnOptions, SIGNAL(clicked()), this, SLOT(editOptions()));
238         QObject::connect(btnStart, SIGNAL(clicked()), this, SLOT(startAction()));
239
240         // Init configInfo
241         initConfigInfo(configInfo);
242
243         // Read config
244         QString error = readChannelVec(configInfo, channelVec);
245         if (!error.isEmpty()) QMessageBox::warning(this, tr("Problem when reading the configuration file"), error);
246
247         // Fill in channels
248         updateLwChannels();
249
250         // Default date
251         QDateTime dateTime = QDateTime::currentDateTime(); // set the default date to today if it is past midday
252         if (dateTime.time().hour() < 12) dateTime = dateTime.addDays(-1);
253         calDate->setSelectedDate(dateTime.date());
254 }
255
256
257 void MainDialog::editOptions() {
258         OptionsDialog *od = new OptionsDialog();
259         if (od->exec(configInfo.userConfigFile)) {
260                 channelVec.clear();
261                 QString error = readChannelVec(configInfo, channelVec);
262                 if (!error.isEmpty()) QMessageBox::warning(this, tr("Problem when reading the configuration file"), error);
263                 updateLwChannels();
264         }
265         delete od;
266 }
267
268
269 void MainDialog::updateLwChannels() {
270         lwChannels->clear();
271         for (int i = 0; i != channelVec.size(); ++i) lwChannels->addItem(channelVec[i].fullName);
272 }
273
274
275 bool MainDialog::startAction() {
276         QListWidgetItem* selectedChannel = lwChannels->selectedItems().at(0);
277         int row = lwChannels->row(selectedChannel);
278         if (row > -1) {
279                 Channel channel = channelVec[row];
280                 QDate date = calDate->selectedDate();
281                 QString substUrl;
282                 QString errorMsg;
283                 if (!evaluateStaticUrl(channel.staticUrl, date, substUrl, errorMsg)) {
284                         QMessageBox::warning(this, tr("Problem when substituting URL"), errorMsg);
285                         return false;
286                 }
287                 QStringList arguments;
288                 arguments.append(substUrl);
289                 appendPlayerOffsetOption(channel.player, teOffset->time(), arguments);
290                 QProcess player(this);
291                 qDebug() << channel.player << arguments;
292                 player.start(channel.player, arguments);
293                 player.waitForFinished(-1);
294                 return true;
295         }
296         return false;
297 }
298
299
300
301 // Main function
302 // =============
303
304 int main(int argc, char *argv[]) {
305         QApplication app(argc, argv);
306         QString locale = QLocale::system().name();
307         QTranslator translator;
308         translator.load(QString(":/qteleschorsch_") + locale);
309         app.installTranslator(&translator);
310         MainDialog *mainDialog = new MainDialog();
311         mainDialog->show();
312         return app.exec();
313