sgwdynspeed: rename 2 variables
[olsrd.git] / lib / sgwdynspeed / src / speedFile.c
1 #include "speedFile.h"
2
3 /* Plugin includes */
4 #include "sgwDynSpeed.h"
5
6 /* OLSRD includes */
7 #include "olsr_cfg.h"
8 #include "gateway.h"
9
10 /* System includes */
11 #include <stddef.h>
12 #include <unistd.h>
13 #include <fcntl.h>
14 #include <stdlib.h>
15 #include <regex.h>
16 #include <errno.h>
17 #include <sys/stat.h>
18 #include <stdio.h>
19 #include <assert.h>
20
21 #define SPEED_UPLINK_NAME   "upstream"
22 #define SPEED_DOWNLINK_NAME "downstream"
23
24 /** the maximal length of a line that is read from the file */
25 #define LINE_LENGTH 256
26
27 /** regular expression describing a comment */
28 static const char * regexCommentString = "^([[:space:]]*|[[:space:]#]+.*)$";
29
30 /** regular expression describing a key/value pair */
31 static const char * regexNameValueString =
32                 "^[[:space:]]*([^[:space:]]+)[[:space:]]*=[[:space:]]*(.*?)[[:space:]]*$";
33
34 /** the number of matches in regexNameValueString */
35 static const size_t regexNameValuematchCount = 3;
36
37 /** the compiled regular expression describing a comment */
38 static regex_t regexComment;
39
40 /** the compiled regular expression describing a key/value pair */
41 static regex_t regexNameValue;
42
43 /** true when the plugin has been started */
44 static bool started = false;
45
46 /** type to hold the cached stat result */
47 typedef struct _CachedStat {
48         time_t timeStamp; /* Time of last modification (second resolution) */
49 } CachedStat;
50
51 /** the cached stat result */
52 static CachedStat cachedStat;
53
54 /**
55  Read an unsigned long number from a value string
56
57  @param valueName
58  the name of the value
59  @param value
60  the string to convert to a number
61  @param valueNumber
62  a pointer to the location where to store the number upon successful conversion
63
64  @return
65  - true on success
66  - false otherwise
67  */
68 static bool readUL(const char * valueName, const char * value, unsigned long * valueNumber) {
69         char * endPtr = NULL;
70         unsigned long valueNew;
71
72         assert(valueName != NULL);
73         assert(value != NULL);
74         assert(valueNumber != NULL);
75
76         errno = 0;
77         valueNew = strtoul(value, &endPtr, 10);
78
79         if (!((endPtr != value) && (*value != '\0') && (*endPtr == '\0'))) {
80                 /* invalid conversion */
81                 sgwDynSpeedError(false, "Value of parameter %s (%s) could not be converted to a number", valueName, value);
82                 return false;
83         }
84
85         *valueNumber = valueNew;
86
87         return true;
88 }
89
90 /**
91  * Strip EOL characters from a string
92  *
93  * @param str the string to strip
94  */
95 static void stripEols(char * str) {
96   size_t len = strlen(str);
97   while (len && ((str[len - 1] == '\n') || (str[len - 1] == '\r'))) {
98     len--;
99   }
100   str[len] = '\0';
101 }
102
103 /**
104  * Initialises the speedFile reader.
105  * @return true upon success, false otherwise
106  */
107 bool startSpeedFile(void) {
108         if (started) {
109                 return true;
110         }
111
112         if (regcomp(&regexComment, regexCommentString, REG_EXTENDED | REG_ICASE)) {
113                 sgwDynSpeedError(false, "Could not compile regex \"%s\"", regexCommentString);
114                 return false;
115         }
116
117         if (regcomp(&regexNameValue, regexNameValueString, REG_EXTENDED | REG_ICASE)) {
118                 sgwDynSpeedError(false, "Could not compile regex \"%s\"", regexNameValueString);
119                 regfree(&regexComment);
120                 return false;
121         }
122
123         cachedStat.timeStamp = -1;
124
125         started = true;
126         return true;
127 }
128
129 /**
130  * Cleans up the speedFile reader.
131  */
132 void stopSpeedFile(void) {
133         if (started) {
134                 regfree(&regexNameValue);
135                 regfree(&regexComment);
136                 started = false;
137         }
138 }
139
140 /**
141  * Performs a regex match
142  * @param regex the compiled regex to match against
143  * @param line the line to match
144  * @param nmatch the number of matches to produce
145  * @param pmatch the array with match information
146  * @return true upon success, false otherwise
147  */
148 static bool regexMatch(regex_t * regex, char * line, size_t nmatch, regmatch_t pmatch[]) {
149         int result = regexec(regex, line, nmatch, pmatch, 0);
150         if (!result) {
151                 return true;
152         }
153
154         if (result == REG_NOMATCH) {
155                 return false;
156         }
157
158         {
159                 char msgbuf[256];
160                 regerror(result, regex, msgbuf, sizeof(msgbuf));
161                 sgwDynSpeedError(false, "Regex match failed: %s", msgbuf);
162         }
163
164         return false;
165 }
166
167 /** the buffer in which to store a line read from the file */
168 static char line[LINE_LENGTH];
169
170 static bool reportedErrorsPrevious = false;
171
172 /**
173  * Read the speed file
174  * @param fileName the filename
175  */
176 void readSpeedFile(char * fileName) {
177         int fd;
178         struct stat statBuf;
179         FILE * fp = NULL;
180         unsigned int lineNumber = 0;
181         char * name = NULL;
182         char * value = NULL;
183         unsigned long uplink = DEF_UPLINK_SPEED;
184         unsigned long downlink = DEF_DOWNLINK_SPEED;
185         bool uplinkSet = false;
186         bool downlinkSet = false;
187         bool reportedErrors = false;
188
189         fd = open(fileName, O_RDONLY);
190         if (fd < 0) {
191                 /* could not access the file */
192                 goto out;
193         }
194
195         if (fstat(fd, &statBuf)) {
196                 /* could not access the file */
197                 goto out;
198         }
199
200         if (!memcmp(&cachedStat.timeStamp, &statBuf.st_mtime, sizeof(cachedStat.timeStamp))) {
201                 /* file did not change since last read */
202                 goto out;
203         }
204
205         fp = fdopen(fd, "r");
206         if (!fp) {
207                 goto out;
208         }
209
210         memcpy(&cachedStat.timeStamp, &statBuf.st_mtime, sizeof(cachedStat.timeStamp));
211
212         while (fgets(line, LINE_LENGTH, fp)) {
213                 regmatch_t pmatch[regexNameValuematchCount];
214
215                 lineNumber++;
216
217                 if (regexMatch(&regexComment, line, 0, NULL)) {
218                         continue;
219                 }
220
221                 if (!regexMatch(&regexNameValue, line, regexNameValuematchCount, pmatch)) {
222                         sgwDynSpeedError(false, "Gateway speed file \"%s\", line %d uses invalid syntax: %s", fileName, lineNumber,
223                                         line);
224                         goto out;
225                 }
226
227                 stripEols(line);
228
229                 /* determine name/value */
230                 name = &line[pmatch[1].rm_so];
231                 line[pmatch[1].rm_eo] = '\0';
232                 value = &line[pmatch[2].rm_so];
233                 line[pmatch[2].rm_eo] = '\0';
234
235                 if (!strncasecmp(SPEED_UPLINK_NAME, name, sizeof(line))) {
236                         if (!readUL(SPEED_UPLINK_NAME, value, &uplink)) {
237                                 goto out;
238                         }
239                         uplinkSet = true;
240                 } else if (!strncasecmp(SPEED_DOWNLINK_NAME, name, sizeof(line))) {
241                         if (!readUL(SPEED_DOWNLINK_NAME, value, &downlink)) {
242                                 goto out;
243                         }
244                         downlinkSet = true;
245                 } else {
246                   if (!reportedErrorsPrevious) {
247                     sgwDynSpeedError(false, "Gateway speed file \"%s\", line %d specifies an unknown option \"%s\": ignored",
248                         fileName, lineNumber, name);
249                     reportedErrors = true;
250                   }
251                 }
252         }
253
254         reportedErrorsPrevious = reportedErrors;
255
256         fclose(fp);
257         fp = NULL;
258
259         if (uplinkSet) {
260                 olsr_cnf->smart_gw_uplink = uplink;
261         }
262         if (downlinkSet) {
263                 olsr_cnf->smart_gw_downlink = downlink;
264         }
265         if (uplinkSet || downlinkSet) {
266           refresh_smartgw_netmask();
267         }
268
269         out: if (fp) {
270                 fclose(fp);
271         }
272         if (fd >= 0) {
273                 close(fd);
274         }
275         return;
276 }