Implemented the Log package for logging

This commit is contained in:
Leon Baker
2015-06-16 12:34:30 +02:00
parent 8746179952
commit 882ca25f76
2 changed files with 89 additions and 74 deletions

View File

@@ -34,6 +34,7 @@ import (
"reflect" "reflect"
"strings" "strings"
"unsafe" "unsafe"
"log"
) )
type sockaddr_in struct { type sockaddr_in struct {
@@ -75,6 +76,7 @@ type Milter interface {
GetDebug() bool GetDebug() bool
GetFlags() int GetFlags() int
GetSocket() string GetSocket() string
GetLogger() *log.Logger
} }
// An "empty" Milter with no callback functions // An "empty" Milter with no callback functions
@@ -83,6 +85,7 @@ type MilterRaw struct {
Debug bool Debug bool
Flags int Flags int
Socket string Socket string
Logger *log.Logger
} }
func (m *MilterRaw) GetFilterName() string { func (m *MilterRaw) GetFilterName() string {
@@ -101,6 +104,10 @@ func (m *MilterRaw) GetSocket() string {
return m.Socket return m.Socket
} }
func (m *MilterRaw) GetLogger() *log.Logger {
return m.Logger
}
// ********* Callback checking types ********* // ********* Callback checking types *********
type checkForConnect interface { type checkForConnect interface {
Connect(ctx uintptr, hostname string, ip net.IP) (sfsistat int8) Connect(ctx uintptr, hostname string, ip net.IP) (sfsistat int8)
@@ -144,6 +151,7 @@ type checkForClose interface {
// ********* Global Milter variable ********* // ********* Global Milter variable *********
var milter Milter var milter Milter
var logger *log.Logger
// ********* Utility Functions (not exported) ********* // ********* Utility Functions (not exported) *********
@@ -222,7 +230,7 @@ func Go_xxfi_connect(ctx *C.SMFICTX, hostname *C.char, hostaddr *C._SOCK_ADDR) C
ip = net.ParseIP(C.GoString((*C.char)(unsafe.Pointer(&dst)))) ip = net.ParseIP(C.GoString((*C.char)(unsafe.Pointer(&dst))))
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("hostaddr.sa_family value not implemented") logger.Println("hostaddr.sa_family value not implemented")
} }
ip = net.ParseIP("::") ip = net.ParseIP("::")
} }
@@ -230,7 +238,7 @@ func Go_xxfi_connect(ctx *C.SMFICTX, hostname *C.char, hostaddr *C._SOCK_ADDR) C
m := milter.(checkForConnect) m := milter.(checkForConnect)
code := m.Connect(ctxptr, C.GoString(hostname), ip) code := m.Connect(ctxptr, C.GoString(hostname), ip)
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Connect callback returned: %d\n", code) logger.Printf("Connect callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -240,7 +248,7 @@ func Go_xxfi_helo(ctx *C.SMFICTX, helohost *C.char) C.sfsistat {
m := milter.(checkForHelo) m := milter.(checkForHelo)
code := m.Helo(ctx2int(ctx), C.GoString(helohost)) code := m.Helo(ctx2int(ctx), C.GoString(helohost))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Helo callback returned: %d\n", code) logger.Printf("Helo callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -251,7 +259,7 @@ func Go_xxfi_envfrom(ctx *C.SMFICTX, argv **C.char) C.sfsistat {
m := milter.(checkForEnvFrom) m := milter.(checkForEnvFrom)
code := m.EnvFrom(ctx2int(ctx), cStringArrayToSlice(argv)) code := m.EnvFrom(ctx2int(ctx), cStringArrayToSlice(argv))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("EnvFrom callback returned: %d\n", code) logger.Printf("EnvFrom callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -262,7 +270,7 @@ func Go_xxfi_envrcpt(ctx *C.SMFICTX, argv **C.char) C.sfsistat {
m := milter.(checkForEnvRcpt) m := milter.(checkForEnvRcpt)
code := m.EnvRcpt(ctx2int(ctx), cStringArrayToSlice(argv)) code := m.EnvRcpt(ctx2int(ctx), cStringArrayToSlice(argv))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("EnvRcpt callback returned: %d\n", code) logger.Printf("EnvRcpt callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -272,7 +280,7 @@ func Go_xxfi_header(ctx *C.SMFICTX, headerf, headerv *C.char) C.sfsistat {
m := milter.(checkForHeader) m := milter.(checkForHeader)
code := m.Header(ctx2int(ctx), C.GoString(headerf), C.GoString(headerv)) code := m.Header(ctx2int(ctx), C.GoString(headerf), C.GoString(headerv))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Header callback returned: %d\n", code) logger.Printf("Header callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -283,7 +291,7 @@ func Go_xxfi_eoh(ctx *C.SMFICTX) C.sfsistat {
m := milter.(checkForEoh) m := milter.(checkForEoh)
code := m.Eoh(ctx2int(ctx)) code := m.Eoh(ctx2int(ctx))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Eoh callback returned: %d\n", code) logger.Printf("Eoh callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -300,7 +308,7 @@ func Go_xxfi_body(ctx *C.SMFICTX, bodyp *C.uchar, bodylen C.size_t) C.sfsistat {
m := milter.(checkForBody) m := milter.(checkForBody)
code := m.Body(ctx2int(ctx), b) code := m.Body(ctx2int(ctx), b)
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Body callback returned: %d\n", code) logger.Printf("Body callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -311,7 +319,7 @@ func Go_xxfi_eom(ctx *C.SMFICTX) C.sfsistat {
m := milter.(checkForEom) m := milter.(checkForEom)
code := m.Eom(ctx2int(ctx)) code := m.Eom(ctx2int(ctx))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Eom callback returned: %d\n", code) logger.Printf("Eom callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -322,7 +330,7 @@ func Go_xxfi_abort(ctx *C.SMFICTX) C.sfsistat {
m := milter.(checkForAbort) m := milter.(checkForAbort)
code := m.Abort(ctx2int(ctx)) code := m.Abort(ctx2int(ctx))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Abort callback returned: %d\n", code) logger.Printf("Abort callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -333,7 +341,7 @@ func Go_xxfi_close(ctx *C.SMFICTX) C.sfsistat {
m := milter.(checkForClose) m := milter.(checkForClose)
code := m.Close(ctx2int(ctx)) code := m.Close(ctx2int(ctx))
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Close callback returned: %d\n", code) logger.Printf("Close callback returned: %d\n", code)
} }
return C.sfsistat(code) return C.sfsistat(code)
} }
@@ -604,14 +612,17 @@ func progress(ctx uintptr) int {
// ********* Run the milter ********* // ********* Run the milter *********
func Stop() {
C.smfi_stop()
}
func Run(amilter Milter) int { func Run(amilter Milter) int {
milter = amilter milter = amilter
// Setup logging
logger = milter.GetLogger()
if logger == nil {
// No logger defined so create a simple logger to Stdout
logger = log.New(os.Stdout, "", 0)
}
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Debugging enabled") logger.Println("Debugging enabled")
} }
// Declare an empty smfiDesc structure // Declare an empty smfiDesc structure
@@ -622,7 +633,7 @@ func Run(amilter Milter) int {
defer C.free(unsafe.Pointer(fname)) defer C.free(unsafe.Pointer(fname))
smfilter.xxfi_name = fname smfilter.xxfi_name = fname
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Filter Name: %s\n", C.GoString(smfilter.xxfi_name)) logger.Printf("Filter Name: %s\n", C.GoString(smfilter.xxfi_name))
} }
// Set version code // Set version code
@@ -631,7 +642,7 @@ func Run(amilter Milter) int {
// Set Flags // Set Flags
smfilter.xxfi_flags = C.ulong(milter.GetFlags()) smfilter.xxfi_flags = C.ulong(milter.GetFlags())
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("Flags: 0x%b\n", smfilter.xxfi_flags) logger.Printf("Flags: 0x%b\n", smfilter.xxfi_flags)
} }
// Set Callbacks if they are implemented // Set Callbacks if they are implemented
@@ -639,117 +650,117 @@ func Run(amilter Milter) int {
// Check if Connect method was implemented // Check if Connect method was implemented
if _, ok := milter.(checkForConnect); ok { if _, ok := milter.(checkForConnect); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Connect callback implemented") logger.Println("Connect callback implemented")
} }
C.setConnect(&smfilter) C.setConnect(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Connect callback not implemented") logger.Println("Connect callback not implemented")
} }
} }
// Check if Helo method was implemented // Check if Helo method was implemented
if _, ok := milter.(checkForHelo); ok { if _, ok := milter.(checkForHelo); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Helo callback implemented") logger.Println("Helo callback implemented")
} }
C.setHelo(&smfilter) C.setHelo(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Helo callback not implemented") logger.Println("Helo callback not implemented")
} }
} }
// Check if EnvFrom method was implemented // Check if EnvFrom method was implemented
if _, ok := milter.(checkForEnvFrom); ok { if _, ok := milter.(checkForEnvFrom); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("EnvFrom callback implemented") logger.Println("EnvFrom callback implemented")
} }
C.setEnvFrom(&smfilter) C.setEnvFrom(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("EnvFrom callback not implemented") logger.Println("EnvFrom callback not implemented")
} }
} }
// Check if EnvRcpt method was implemented // Check if EnvRcpt method was implemented
if _, ok := milter.(checkForEnvRcpt); ok { if _, ok := milter.(checkForEnvRcpt); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("EnvRcpt callback implemented") logger.Println("EnvRcpt callback implemented")
} }
C.setEnvRcpt(&smfilter) C.setEnvRcpt(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("EnvRcpt callback not implemented") logger.Println("EnvRcpt callback not implemented")
} }
} }
// Check if Header method was implemented // Check if Header method was implemented
if _, ok := milter.(checkForHeader); ok { if _, ok := milter.(checkForHeader); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Header callback implemented") logger.Println("Header callback implemented")
} }
C.setHeader(&smfilter) C.setHeader(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Header callback not implemented") logger.Println("Header callback not implemented")
} }
} }
// Check if Eoh method was implemented // Check if Eoh method was implemented
if _, ok := milter.(checkForEoh); ok { if _, ok := milter.(checkForEoh); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Eoh callback implemented") logger.Println("Eoh callback implemented")
} }
C.setEoh(&smfilter) C.setEoh(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Eoh callback not implemented") logger.Println("Eoh callback not implemented")
} }
} }
// Check if Body method was implemented // Check if Body method was implemented
if _, ok := milter.(checkForBody); ok { if _, ok := milter.(checkForBody); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Body callback implemented") logger.Println("Body callback implemented")
} }
C.setBody(&smfilter) C.setBody(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Body callback not implemented") logger.Println("Body callback not implemented")
} }
} }
// Check if Eom method was implemented // Check if Eom method was implemented
if _, ok := milter.(checkForEom); ok { if _, ok := milter.(checkForEom); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Eom callback implemented") logger.Println("Eom callback implemented")
} }
C.setEom(&smfilter) C.setEom(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Eom callback not implemented") logger.Println("Eom callback not implemented")
} }
} }
// Check if Abort method was implemented // Check if Abort method was implemented
if _, ok := milter.(checkForAbort); ok { if _, ok := milter.(checkForAbort); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Abort callback implemented") logger.Println("Abort callback implemented")
} }
C.setAbort(&smfilter) C.setAbort(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Abort callback not implemented") logger.Println("Abort callback not implemented")
} }
} }
// Check if Close method was implemented // Check if Close method was implemented
if _, ok := milter.(checkForClose); ok { if _, ok := milter.(checkForClose); ok {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Close callback implemented") logger.Println("Close callback implemented")
} }
C.setClose(&smfilter) C.setClose(&smfilter)
} else { } else {
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Close callback not implemented") logger.Println("Close callback not implemented")
} }
} }
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("smfilter:") logger.Println("smfilter:")
LoggerPrintln(fmt.Sprint(smfilter)) logger.Println(fmt.Sprint(smfilter))
} }
// Setup socket connection // Setup socket connection
@@ -766,29 +777,26 @@ func Run(amilter Milter) int {
csocket := C.CString(socket) csocket := C.CString(socket)
defer C.free(unsafe.Pointer(csocket)) defer C.free(unsafe.Pointer(csocket))
if code := C.smfi_setconn(csocket); code != 0 { if code := C.smfi_setconn(csocket); code != 0 {
LoggerPrintf("smfi_setconn failed: %d\n", code) logger.Printf("smfi_setconn failed: %d\n", code)
} }
// Register the filter // Register the filter
if code := C.smfi_register(smfilter); code == C.MI_FAILURE { if code := C.smfi_register(smfilter); code == C.MI_FAILURE {
LoggerPrintf("smfi_register failed: %d\n", code) logger.Printf("smfi_register failed: %d\n", code)
} }
// Hand control to libmilter // Hand control to libmilter
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintln("Handing over to libmilter") logger.Println("Handing over to libmilter")
} }
result := C.smfi_main() result := C.smfi_main()
if milter.GetDebug() { if milter.GetDebug() {
LoggerPrintf("smfi_main returned: %v\n", result) logger.Printf("smfi_main returned: %v\n", result)
} }
return int(result) return int(result)
} }
var LoggerPrintln func(...interface{}) func Stop() {
var LoggerPrintf func(string, ...interface{}) C.smfi_stop()
func init() {
LoggerPrintln = func(i ...interface{}) { fmt.Println(i...) }
LoggerPrintf = func(i string, j ...interface{}) { fmt.Printf(i, j...) }
} }

View File

@@ -7,7 +7,8 @@ Copyright (c) 2015 Leon Baker
package main package main
import ( import (
"fmt" "log"
"os"
m "github.com/leonrbaker/gomilter" m "github.com/leonrbaker/gomilter"
) )
@@ -22,11 +23,13 @@ type T struct {
C string C string
} }
var logger *log.Logger
// Define the callback functions we are going to use // Define the callback functions we are going to use
func (milter *Mymilter) Connect(ctx uintptr, hostname, ip string) (sfsistat int8) { func (milter *Mymilter) Connect(ctx uintptr, hostname, ip string) (sfsistat int8) {
fmt.Println("mymilter.Connect was called") logger.Println("mymilter.Connect was called")
fmt.Printf("hostname: %s\n", hostname) logger.Printf("hostname: %s\n", hostname)
fmt.Printf("ip: %s\n", ip) logger.Printf("ip: %s\n", ip)
t := T{1, hostname, "Test"} t := T{1, hostname, "Test"}
m.SetPriv(ctx, &t) m.SetPriv(ctx, &t)
@@ -35,53 +38,53 @@ func (milter *Mymilter) Connect(ctx uintptr, hostname, ip string) (sfsistat int8
} }
func (milter *Mymilter) Helo(ctx uintptr, helohost string) (sfsistat int8) { func (milter *Mymilter) Helo(ctx uintptr, helohost string) (sfsistat int8) {
fmt.Println("mymilter.Helo was called") logger.Println("mymilter.Helo was called")
fmt.Printf("helohost: %s\n", helohost) logger.Printf("helohost: %s\n", helohost)
return return
} }
func (milter *Mymilter) EnvFrom(ctx uintptr, myargv []string) (sfsistat int8) { func (milter *Mymilter) EnvFrom(ctx uintptr, myargv []string) (sfsistat int8) {
fmt.Println("mymilter.EnvFrom was called") logger.Println("mymilter.EnvFrom was called")
fmt.Printf("myargv: %s\n", myargv) logger.Printf("myargv: %s\n", myargv)
// Show the value of a symbol // Show the value of a symbol
fmt.Printf("{mail_addr}: %v\n", m.GetSymVal(ctx, "{mail_addr}")) logger.Printf("{mail_addr}: %v\n", m.GetSymVal(ctx, "{mail_addr}"))
return return
} }
func (milter *Mymilter) EnvRcpt(ctx uintptr, myargv []string) (sfsistat int8) { func (milter *Mymilter) EnvRcpt(ctx uintptr, myargv []string) (sfsistat int8) {
fmt.Println("mymilter.EnvRcpt was called") logger.Println("mymilter.EnvRcpt was called")
fmt.Printf("myargv: %s\n", myargv) logger.Printf("myargv: %s\n", myargv)
// Show the value of a symbol // Show the value of a symbol
fmt.Printf("{rcpt_addr}: %v\n", m.GetSymVal(ctx, "{rcpt_addr}")) logger.Printf("{rcpt_addr}: %v\n", m.GetSymVal(ctx, "{rcpt_addr}"))
return return
} }
func (milter *Mymilter) Header(ctx uintptr, headerf, headerv string) (sfsistat int8) { func (milter *Mymilter) Header(ctx uintptr, headerf, headerv string) (sfsistat int8) {
fmt.Println("mymilter.Header was called") logger.Println("mymilter.Header was called")
fmt.Printf("header field: %s\n", headerf) logger.Printf("header field: %s\n", headerf)
fmt.Printf("header value: %s\n", headerv) logger.Printf("header value: %s\n", headerv)
return return
} }
func (milter *Mymilter) Eoh(ctx uintptr) (sfsistat int8) { func (milter *Mymilter) Eoh(ctx uintptr) (sfsistat int8) {
fmt.Println("mymilter.Eoh was called") logger.Println("mymilter.Eoh was called")
return return
} }
func (milter *Mymilter) Body(ctx uintptr, body []byte) (sfsistat int8) { func (milter *Mymilter) Body(ctx uintptr, body []byte) (sfsistat int8) {
// Be careful as a conversion of body to string will make a copy of body // Be careful as a conversion of body to string will make a copy of body
fmt.Println("mymilter.Body was called") logger.Println("mymilter.Body was called")
fmt.Println(string(body)) logger.Println(string(body))
fmt.Printf("Body Length: %d\n", len(body)) logger.Printf("Body Length: %d\n", len(body))
return return
} }
func (milter *Mymilter) Eom(ctx uintptr) (sfsistat int8) { func (milter *Mymilter) Eom(ctx uintptr) (sfsistat int8) {
fmt.Println("mymilter.Eom was called") logger.Println("mymilter.Eom was called")
var t T var t T
fmt.Println("m.GetPri:", m.GetPriv(ctx, &t)) logger.Println("m.GetPri:", m.GetPriv(ctx, &t))
fmt.Println("t:", t) logger.Println("t:", t)
m.AddHeader(ctx, "LEONUX-Mailer", m.AddHeader(ctx, "LEONUX-Mailer",
"test server;\n\ttest1=\"foobar\"") "test server;\n\ttest1=\"foobar\"")
@@ -92,19 +95,23 @@ func (milter *Mymilter) Eom(ctx uintptr) (sfsistat int8) {
} }
func (milter *Mymilter) Abort(ctx uintptr) (sfsistat int8) { func (milter *Mymilter) Abort(ctx uintptr) (sfsistat int8) {
fmt.Println("mymilter.Abort was called") logger.Println("mymilter.Abort was called")
return return
} }
func (milter *Mymilter) Close(ctx uintptr) (sfsistat int8) { func (milter *Mymilter) Close(ctx uintptr) (sfsistat int8) {
fmt.Println("mymilter.Close was called") logger.Println("mymilter.Close was called")
return return
} }
func main() { func main() {
mymilter := new(Mymilter) mymilter := new(Mymilter)
mymilter.FilterName = "TestFilter" mymilter.FilterName = "TestFilter"
logger = log.New(os.Stdout, "", log.LstdFlags)
mymilter.Logger = logger
mymilter.Debug = true mymilter.Debug = true
mymilter.Flags = m.ADDHDRS | m.ADDRCPT | m.CHGFROM | m.CHGBODY mymilter.Flags = m.ADDHDRS | m.ADDRCPT | m.CHGFROM | m.CHGBODY
mymilter.Socket = "unix:/var/milterattachcheck/socket" mymilter.Socket = "unix:/var/milterattachcheck/socket"