aboutsummaryrefslogtreecommitdiffstats
path: root/plugin_exec.c
blob: e099433590f041223da543c62a3709955503e258 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
/* $Id: plugin_exec.c,v 1.6 2004/06/26 12:05:00 reinelt Exp $
 *
 * plugin for external processes
 *
 * Copyright 2004 Michael Reinelt <reinelt@eunet.at>
 * Copyright 2004 The LCD4Linux Team <lcd4linux-devel@users.sourceforge.net>
 *
 * based on the old 'exec' client which is
 * Copyright 2001 Leopold T�tsch <lt@toetsch.at>
 *
 *
 * This file is part of LCD4Linux.
 *
 * LCD4Linux 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, or (at your option)
 * any later version.
 *
 * LCD4Linux 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 * $Log: plugin_exec.c,v $
 * Revision 1.6  2004/06/26 12:05:00  reinelt
 *
 * uh-oh... the last CVS log message messed up things a lot...
 *
 * Revision 1.5  2004/06/26 09:27:21  reinelt
 *
 * added '-W' to CFLAGS
 * changed all C++ comments to C ones
 * cleaned up a lot of signed/unsigned mistakes
 *
 * Revision 1.4  2004/06/20 10:09:56  reinelt
 *
 * 'const'ified the whole source
 *
 * Revision 1.3  2004/06/17 06:23:43  reinelt
 *
 * hash handling rewritten to solve performance issues
 *
 * Revision 1.2  2004/04/08 10:48:25  reinelt
 * finished plugin_exec
 * modified thread handling
 * added '%x' format to qprintf (hexadecimal)
 *
 * Revision 1.1  2004/03/20 11:49:40  reinelt
 * forgot to add plugin_exec.c ...
 *
 */

/* 
 * exported functions:
 *
 * int plugin_init_exec (void)
 *  adds functions to start external pocesses
 *
 */


#include "config.h"

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>

#include "debug.h"
#include "plugin.h"
#include "hash.h"
#include "cfg.h"
#include "thread.h"
#include "qprintf.h"


#define NUM_THREADS 16
#define SHM_SIZE 256

typedef struct {
  int   delay;
  int   mutex;
  pid_t pid;
  int   shmid;
  char *cmd;
  char *key;
  char *ret;
} EXEC_THREAD;

static EXEC_THREAD Thread[NUM_THREADS];
static int max_thread = -1;

static HASH EXEC;


/* x^0 + x^5 + x^12 */
#define CRCPOLY 0x8408 
  
static unsigned short CRC (const char *s)
{
  int i;
  unsigned short crc;

  /* seed value */
  crc = 0xffff;
  
  while (*s != '\0') {
    crc ^= *s++;
    for (i = 0; i < 8; i++)
      crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY : 0);
  }
  return crc;
}


static void exec_thread (void *data)
{
  EXEC_THREAD *Thread = (EXEC_THREAD*)data;
  FILE *pipe;
  char buffer[SHM_SIZE];
  int len;
  
  /* use a safe path */
  putenv ("PATH=/usr/local/bin:/usr/bin:/bin");
  
  /* forever... */
  while (1) {
    pipe = popen(Thread->cmd, "r");
    if (pipe == NULL) {
      error("exec error: could not run pipe '%s': %s", Thread->cmd, strerror(errno));
      len = 0;
    } else {
      len = fread(buffer, 1, SHM_SIZE-1, pipe);
      if (len <= 0) {
	error("exec error: could not read from pipe '%s': %s", Thread->cmd, strerror(errno));
	len = 0;
      }
      pclose(pipe);
    }
    
    /* force trailing zero */
    buffer[len] = '\0';
    
    /* remove trailing CR/LF */
    while (len>0 && (buffer[len-1]=='\n' || buffer[len-1]=='\r')) {
      buffer[--len]='\0';
    }
    
    /* lock shared memory */
    mutex_lock(Thread->mutex);
    /* write data */
    strncpy(Thread->ret, buffer, SHM_SIZE);
    /* unlock shared memory */
    mutex_unlock(Thread->mutex);
    usleep (Thread->delay);
  }
}


static void destroy_exec_thread (const int n)
{
  if (Thread[n].mutex != 0) mutex_destroy(Thread[n].mutex); 
  if (Thread[n].cmd) free (Thread[n].cmd);
  if (Thread[n].key) free (Thread[n].key);
  if (Thread[n].ret) shm_destroy (Thread[n].shmid, Thread[n].ret);
  
  Thread[n].delay = 0;
  Thread[n].mutex = 0;
  Thread[n].pid   = 0;
  Thread[n].shmid = 0;
  Thread[n].cmd   = NULL;
  Thread[n].key   = NULL;
  Thread[n].ret   = NULL;
}


static int create_exec_thread (const char *cmd, const char *key, const int delay)
{
  char name[10];

  if (max_thread >= NUM_THREADS) {
    error ("cannot create exec thread <%s>: thread buffer full!", cmd);
    return -1;
  }

  max_thread++;
  Thread[max_thread].delay = delay;
  Thread[max_thread].mutex = mutex_create(); 
  Thread[max_thread].pid   = -1;
  Thread[max_thread].cmd   = strdup(cmd);
  Thread[max_thread].key   = strdup(key);
  Thread[max_thread].ret   = NULL;
    
  /* create communication buffer */
  Thread[max_thread].shmid = shm_create ((void**)&Thread[max_thread].ret, SHM_SIZE);

  /* catch error */
  if (Thread[max_thread].shmid < 0) {
    error ("cannot create exec thread <%s>: shared memory allocation failed!", cmd);
    destroy_exec_thread (max_thread--);
    return -1;
  }
  
  /* create thread */
  qprintf(name, sizeof(name), "exec-%s", key); 
  Thread[max_thread].pid = thread_create (name, exec_thread, &Thread[max_thread]);

  /* catch error */
  if (Thread[max_thread].pid < 0) {
    error ("cannot create exec thread <%s>: fork failed?!", cmd);
    destroy_exec_thread (max_thread--);
    return -1;
  }
  
  return 0;
}    


static int do_exec (const char *cmd, const char *key, int delay)
{
  int i, age;
  
  age = hash_age(&EXEC, key);
  
  if (age < 0) {
    hash_put (&EXEC, key, "");
    /* first-time call: create thread */
    if (delay < 10) {
      error ("exec(%s): delay %d is too short! using 10 msec", cmd, delay);
      delay = 10;
    }
    if (create_exec_thread (cmd, key, 1000*delay)) {
      return -1;
    }
    return 0;
  }
  
  /* reread every 10 msec only */
  if (age > 0 && age <= 10) return 0;
  
  /* find thread */
  for (i = 0; i <= max_thread; i++) {
    if (strcmp(key, Thread[i].key) == 0) {
      /* lock shared memory */
      mutex_lock(Thread[i].mutex);
      /* copy data */
      hash_put (&EXEC, key, Thread[i].ret);
      /* unlock shared memory */
      mutex_unlock(Thread[i].mutex);
      return 0;
    }
  }
  
  error ("internal error: could not find thread exec-%s", key);
  return -1;
}

static void my_exec (RESULT *result, RESULT *arg1, RESULT *arg2)
{
  char *cmd, key[5], *val;
  int delay;
  
  cmd = R2S(arg1);
  delay = (int)R2N(arg2);

  qprintf (key, sizeof(key), "%x", CRC(cmd));
  
  if (do_exec(cmd, key, delay) < 0) {
    SetResult(&result, R_STRING, ""); 
    return;
  }
  
  val = hash_get(&EXEC, key, NULL);
  if (val == NULL) val = "";
  
  SetResult(&result, R_STRING, val); 
}


int plugin_init_exec (void)
{
  hash_create(&EXEC);
  AddFunction ("exec", 2, my_exec);
  return 0;
}


void plugin_exit_exec(void) 
{
  int i;
  
  for (i=0; i<=max_thread; i++) {
    destroy_exec_thread(i);
  }
  
  hash_destroy(&EXEC);
}