From eda2b575f06e72040ebf82d24a7ec1ac84b7948c Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Mon, 9 Apr 2018 23:45:54 +0300 Subject: Refactor UI to use interfaces everywhere --- debug/debug.go | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ debug/doc.go | 2 ++ 2 files changed, 99 insertions(+) create mode 100644 debug/debug.go create mode 100644 debug/doc.go (limited to 'debug') diff --git a/debug/debug.go b/debug/debug.go new file mode 100644 index 0000000..9af3d9d --- /dev/null +++ b/debug/debug.go @@ -0,0 +1,97 @@ +// gomuks - A terminal Matrix client written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// This program 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 3 of the License, or +// (at your option) any later version. +// +// This program 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, see . + +package debug + +import ( + "fmt" + "io" + "io/ioutil" + "os" + "time" + + "runtime/debug" + +) + +var writer io.Writer + +func init() { + var err error + writer, err = os.OpenFile("/tmp/gomuks-debug.log", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644) + if err != nil { + writer = nil + } +} + +func Printf(text string, args ...interface{}) { + if writer != nil { + fmt.Fprintf(writer, time.Now().Format("[2006-01-02 15:04:05] ")) + fmt.Fprintf(writer, text+"\n", args...) + } +} + +func Print(text ...interface{}) { + if writer != nil { + fmt.Fprintf(writer, time.Now().Format("[2006-01-02 15:04:05] ")) + fmt.Fprintln(writer, text...) + } +} + +func PrintStack() { + if writer != nil { + data := debug.Stack() + writer.Write(data) + } +} + +const Oops = ` __________ +< Oh noes! > + ‾‾‾\‾‾‾‾‾‾ + \ ^__^ + \ (XX)\_______ + (__)\ )\/\ + U ||----W | + || ||` + +func PrettyPanic() { + fmt.Println(Oops) + fmt.Println("") + fmt.Println("A fatal error has occurred.") + fmt.Println("") + traceFile := fmt.Sprintf("/tmp/gomuks-panic-%s.txt", time.Now().Format("2006-01-02--15-04-05")) + data := debug.Stack() + err := ioutil.WriteFile(traceFile, data, 0644) + if err != nil { + fmt.Println("Saving the stack trace to", traceFile, "failed:") + fmt.Println("--------------------------------------------------------------------------------") + fmt.Println(err) + fmt.Println("--------------------------------------------------------------------------------") + fmt.Println("") + fmt.Println("You can file an issue at https://github.com/tulir/gomuks/issues.") + fmt.Println("Please provide the file save error (above) and the stack trace of the original error (below) when filing an issue.") + fmt.Println("") + fmt.Println("--------------------------------------------------------------------------------") + debug.PrintStack() + fmt.Println("--------------------------------------------------------------------------------") + } else { + fmt.Println("The stack trace has been saved to", traceFile) + fmt.Println("") + fmt.Println("You can file an issue at https://github.com/tulir/gomuks/issues.") + fmt.Println("Please provide the contents of that file when filing an issue.") + } + os.Exit(1) +} diff --git a/debug/doc.go b/debug/doc.go new file mode 100644 index 0000000..253441c --- /dev/null +++ b/debug/doc.go @@ -0,0 +1,2 @@ +// Package debug contains utilities to log debug messages and display panics nicely. +package debug -- cgit v1.2.3