Modules/syslogmodule.c

   1 /***********************************************************
   2 Copyright 1994 by Lance Ellinghouse,
   3 Cathedral City, California Republic, United States of America.
   4
   5                         All Rights Reserved
   6
   7 Permission to use, copy, modify, and distribute this software and its
   8 documentation for any purpose and without fee is hereby granted,
   9 provided that the above copyright notice appear in all copies and that
  10 both that copyright notice and this permission notice appear in
  11 supporting documentation, and that the name of Lance Ellinghouse
  12 not be used in advertising or publicity pertaining to distribution
  13 of the software without specific, written prior permission.
  14
  15 LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO
  16 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  17 FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE BE LIABLE FOR ANY SPECIAL,
  18 INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
  19 FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  20 NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
  21 WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22
  23 ******************************************************************/
  24
  25 /******************************************************************
  26
  27 Revision history:
  28
  29 1998/04/28 (Sean Reifschneider)
  30   - When facility not specified to syslog() method, use default from openlog()
  31     (This is how it was claimed to work in the documentation)
  32   - Potential resource leak of o_ident, now cleaned up in closelog()
  33   - Minor comment accuracy fix.
  34
  35 95/06/29 (Steve Clift)
  36   - Changed arg parsing to use PyArg_ParseTuple.
  37   - Added PyErr_Clear() call(s) where needed.
  38   - Fix core dumps if user message contains format specifiers.
  39   - Change openlog arg defaults to match normal syslog behavior.
  40   - Plug memory leak in openlog().
  41   - Fix setlogmask() to return previous mask value.
  42
  43 ******************************************************************/
  44
  45 /* syslog module */
  46
  47 #include "Python.h"
  48
  49 #include <syslog.h>
  50
  51 /*  only one instance, only one syslog, so globals should be ok  */
  52 static PyObject *S_ident_o = NULL;                      /*  identifier, held by openlog()  */
  53
  54
  55 static PyObject *
  56 syslog_openlog(PyObject * self, PyObject * args)
  57 {
  58         long logopt = 0;
  59         long facility = LOG_USER;
  60
  61
  62         Py_XDECREF(S_ident_o);
  63         if (!PyArg_ParseTuple(args,
  64                               "S|ll;ident string [, logoption [, facility]]",
  65                               &S_ident_o, &logopt, &facility))
  66                 return NULL;
  67
  68         /* This is needed because openlog() does NOT make a copy
  69          * and syslog() later uses it.. cannot trash it.
  70          */
  71         Py_INCREF(S_ident_o);
  72
  73         openlog(PyString_AsString(S_ident_o), logopt, facility);
  74
  75         Py_INCREF(Py_None);
  76         return Py_None;
  77 }
  78
  79
  80 static PyObject *
  81 syslog_syslog(PyObject * self, PyObject * args)
  82 {
  83         char *message;
  84         int   priority = LOG_INFO;
  85
  86         if (!PyArg_ParseTuple(args, "is;[priority,] message string",
  87                               &priority, &message)) {
  88                 PyErr_Clear();
  89                 if (!PyArg_ParseTuple(args, "s;[priority,] message string",
  90                                       &message))
  91                         return NULL;
  92         }
  93
  94         syslog(priority, "%s", message);
  95         Py_INCREF(Py_None);
  96         return Py_None;
  97 }
  98
  99 static PyObject *
 100 syslog_closelog(PyObject *self, PyObject *args)
 101 {
 102         if (!PyArg_ParseTuple(args, ":closelog"))
 103                 return NULL;
 104         closelog();
 105         Py_XDECREF(S_ident_o);
 106         S_ident_o = NULL;
 107         Py_INCREF(Py_None);
 108         return Py_None;
 109 }
 110
 111 static PyObject *
 112 syslog_setlogmask(PyObject *self, PyObject *args)
 113 {
 114         long maskpri, omaskpri;
 115
 116         if (!PyArg_ParseTuple(args, "l;mask for priority", &maskpri))
 117                 return NULL;
 118         omaskpri = setlogmask(maskpri);
 119         return PyInt_FromLong(omaskpri);
 120 }
 121
 122 static PyObject *
 123 syslog_log_mask(PyObject *self, PyObject *args)
 124 {
 125         long mask;
 126         long pri;
 127         if (!PyArg_ParseTuple(args, "l:LOG_MASK", &pri))
 128                 return NULL;
 129         mask = LOG_MASK(pri);
 130         return PyInt_FromLong(mask);
 131 }
 132
 133 static PyObject *
 134 syslog_log_upto(PyObject *self, PyObject *args)
 135 {
 136         long mask;
 137         long pri;
 138         if (!PyArg_ParseTuple(args, "l:LOG_UPTO", &pri))
 139                 return NULL;
 140         mask = LOG_UPTO(pri);
 141         return PyInt_FromLong(mask);
 142 }
 143
 144 /* List of functions defined in the module */
 145
 146 static PyMethodDef syslog_methods[] = {
 147         {"openlog",     syslog_openlog,         METH_VARARGS},
 148         {"closelog",    syslog_closelog,        METH_VARARGS},
 149         {"syslog",      syslog_syslog,          METH_VARARGS},
 150         {"setlogmask",  syslog_setlogmask,      METH_VARARGS},
 151         {"LOG_MASK",    syslog_log_mask,        METH_VARARGS},
 152         {"LOG_UPTO",    syslog_log_upto,        METH_VARARGS},
 153         {NULL,          NULL,                   0}
 154 };
 155
 156 /* Initialization function for the module */
 157
 158 PyMODINIT_FUNC
 159 initsyslog(void)
 160 {
 161         PyObject *m;
 162
 163         /* Create the module and add the functions */
 164         m = Py_InitModule("syslog", syslog_methods);
 165
 166         /* Add some symbolic constants to the module */
 167
 168         /* Priorities */
 169         PyModule_AddIntConstant(m, "LOG_EMERG",   LOG_EMERG);
 170         PyModule_AddIntConstant(m, "LOG_ALERT",   LOG_ALERT);
 171         PyModule_AddIntConstant(m, "LOG_CRIT",    LOG_CRIT);
 172         PyModule_AddIntConstant(m, "LOG_ERR",     LOG_ERR);
 173         PyModule_AddIntConstant(m, "LOG_WARNING", LOG_WARNING);
 174         PyModule_AddIntConstant(m, "LOG_NOTICE",  LOG_NOTICE);
 175         PyModule_AddIntConstant(m, "LOG_INFO",    LOG_INFO);
 176         PyModule_AddIntConstant(m, "LOG_DEBUG",   LOG_DEBUG);
 177
 178         /* openlog() option flags */
 179         PyModule_AddIntConstant(m, "LOG_PID",     LOG_PID);
 180         PyModule_AddIntConstant(m, "LOG_CONS",    LOG_CONS);
 181         PyModule_AddIntConstant(m, "LOG_NDELAY",  LOG_NDELAY);
 182 #ifdef LOG_NOWAIT
 183         PyModule_AddIntConstant(m, "LOG_NOWAIT",  LOG_NOWAIT);
 184 #endif
 185 #ifdef LOG_PERROR
 186         PyModule_AddIntConstant(m, "LOG_PERROR",  LOG_PERROR);
 187 #endif
 188
 189         /* Facilities */
 190         PyModule_AddIntConstant(m, "LOG_KERN",    LOG_KERN);
 191         PyModule_AddIntConstant(m, "LOG_USER",    LOG_USER);
 192         PyModule_AddIntConstant(m, "LOG_MAIL",    LOG_MAIL);
 193         PyModule_AddIntConstant(m, "LOG_DAEMON",  LOG_DAEMON);
 194         PyModule_AddIntConstant(m, "LOG_AUTH",    LOG_AUTH);
 195         PyModule_AddIntConstant(m, "LOG_LPR",     LOG_LPR);
 196         PyModule_AddIntConstant(m, "LOG_LOCAL0",  LOG_LOCAL0);
 197         PyModule_AddIntConstant(m, "LOG_LOCAL1",  LOG_LOCAL1);
 198         PyModule_AddIntConstant(m, "LOG_LOCAL2",  LOG_LOCAL2);
 199         PyModule_AddIntConstant(m, "LOG_LOCAL3",  LOG_LOCAL3);
 200         PyModule_AddIntConstant(m, "LOG_LOCAL4",  LOG_LOCAL4);
 201         PyModule_AddIntConstant(m, "LOG_LOCAL5",  LOG_LOCAL5);
 202         PyModule_AddIntConstant(m, "LOG_LOCAL6",  LOG_LOCAL6);
 203         PyModule_AddIntConstant(m, "LOG_LOCAL7",  LOG_LOCAL7);
 204
 205 #ifndef LOG_SYSLOG
 206 #define LOG_SYSLOG              LOG_DAEMON
 207 #endif
 208 #ifndef LOG_NEWS
 209 #define LOG_NEWS                LOG_MAIL
 210 #endif
 211 #ifndef LOG_UUCP
 212 #define LOG_UUCP                LOG_MAIL
 213 #endif
 214 #ifndef LOG_CRON
 215 #define LOG_CRON                LOG_DAEMON
 216 #endif
 217
 218         PyModule_AddIntConstant(m, "LOG_SYSLOG",  LOG_SYSLOG);
 219         PyModule_AddIntConstant(m, "LOG_CRON",    LOG_CRON);
 220         PyModule_AddIntConstant(m, "LOG_UUCP",    LOG_UUCP);
 221         PyModule_AddIntConstant(m, "LOG_NEWS",    LOG_NEWS);
 222 }