miki

Miki: personal wiki with the fmd markup format
git clone https://wtenison.com/repo/miki.git
Log | Files | Refs | README | LICENSE

commit 070bf5debe4a9bfc0bc63d90ccad03ca2476d695
parent 83dfe3d818c4d92a62ea24e0a26482c2ab71da9f
Author: weetat <wtenison@protonmail.com>
Date:   Wed, 26 Feb 2025 19:22:00 +0000

Clean up comments and log statements

Also delete the temp.html test output.

Diffstat:
Msrc/filesystem/filesystem.go | 16+++++++++-------
Msrc/fmd/fmd.go | 14+++++++-------
Msrc/fmd/fmd_test.go | 4++--
Msrc/fmd/parser.go | 2+-
Dsrc/fmd/temp.html | 13-------------
Msrc/network/network.go | 24+++++++++++-------------
6 files changed, 30 insertions(+), 43 deletions(-)

diff --git a/src/filesystem/filesystem.go b/src/filesystem/filesystem.go @@ -73,23 +73,25 @@ func MakeDirectoryPkg(resSig DirectorySignature) (DirectoryPackage, error) { if _f.IsDir() && (resSig.DependencyDepth > 0 || resSig.DependencyDepth == -1) { // Recurse into valid sub-directory files. + // Make directory signature for each sub-file/dir _resDirSig, _err := MakeDirectorySig(_f.Name(), resSig.DependencyDepth, resSig.DependencyPattern) if _err != nil { _retErr := fmt.Errorf("MakeDirectoryPkg:%s", _err) return DirectoryPackage{}, _retErr } + // Make the respective package. _resDirPkg, _err := MakeDirectoryPkg(_resDirSig) if _err != nil { _retErr := fmt.Errorf("MakeDirectoryPkg:%s", _err) return DirectoryPackage{}, _retErr } + // Add to package dependencies list. _resFileDirDeps = append(_resFileDirDeps, _resDirPkg.DependencyFiles...) } else if resSig.DependencyPattern != nil && resSig.DependencyPattern.MatchString(_f.Name()) { // Add files that match pattern to dependency list. - _resPkg.DependencyFiles = append(_resPkg.DependencyFiles, filepath.Join(_resPkg.Root, _f.Name())) } } @@ -111,17 +113,17 @@ func MakeDirectoryPkg(resSig DirectorySignature) (DirectoryPackage, error) { if _df.Name() == _rootDataFile { log.Printf("INFO\tMakeDirectoryPkg:df:%s, rootDataFile:%s", _df.Name(), _rootDataFile) + var _DataContainer struct { PageContent string } - _DataContainer.PageContent = fmd.GetFMDToHTML(filepath.Join(Dirs.DataDirectory, _rootDataFile)) - // log.Printf("INFO\tMakeDirectoryPkg:dataContainer.pageContent:%s", _DataContainer.PageContent) + _DataContainer.PageContent = fmd.WritFMDToHTMLString(filepath.Join(Dirs.DataDirectory, _rootDataFile)) + _resPkg.DependencyData = _DataContainer } } - // log.Printf("INFO\tMakeDirectoryPkg:%v\n", _resPkg) return _resPkg, nil } @@ -131,7 +133,7 @@ func Init() { _fsData, _err := os.ReadFile("sys/config.json") if _err != nil { - log.Panicln("__PANIC\tos.ReadFile:config.json:" + _err.Error()) + log.Panicln("__PANIC\tfilesystem:Init:os.ReadFile:config.json:" + _err.Error()) return } @@ -154,11 +156,11 @@ func Init() { _globalSig, _err := MakeDirectorySig(filepath.Join(Dirs.WebDirectory, "/global"), 0, FilePatternHTML) if _err != nil { - log.Panicf("__PANIC\tnetwork:Init:MakeDirectorySig:%s", _err) + log.Panicf("__PANIC\tfilesystem:Init:MakeDirectorySig:%s", _err) } GlobalPkg, _err = MakeDirectoryPkg(_globalSig) if _err != nil { - log.Panicf("__PANIC\tnetwork:Init:MakeDirectoryPkg:%s", _err) + log.Panicf("__PANIC\tfilesystem:Init:MakeDirectoryPkg:%s", _err) } } diff --git a/src/fmd/fmd.go b/src/fmd/fmd.go @@ -6,10 +6,10 @@ import ( "os" ) -func RenderFMD(filePath string) { - _fileBytes, _err := os.ReadFile(filePath) +func WriteFMDToHTMLFile(inputFile string, outputFile string) { + _fileBytes, _err := os.ReadFile(inputFile) if _err != nil { - log.Println("_ERROR\tRenderFMD:ReadFile:", filePath, ":", _err) + log.Println("_ERROR\tfmd:WriteFMDToHTMLFile:ReadFile:", inputFile, ":", _err) } _l := MakeLexer("RenderLexer", _fileBytes) @@ -22,15 +22,15 @@ func RenderFMD(filePath string) { _outputBytes := bytes.NewBufferString(interpret(_ast)) - if _err = os.WriteFile("temp.html", _outputBytes.Bytes(), 0666); _err != nil { - log.Println("_ERROR\tRenderFMD:os.WriteFile:", filePath, ":", _err) + if _err = os.WriteFile(outputFile, _outputBytes.Bytes(), 0666); _err != nil { + log.Println("_ERROR\tfmd:WriteFMDToHTMLFile:os.WriteFile:", inputFile, ":", _err) } } -func GetFMDToHTML(filePath string) string { +func WritFMDToHTMLString(filePath string) string { _fileBytes, _err := os.ReadFile(filePath) if _err != nil { - log.Println("_ERROR\tRenderFMD:ReadFile:", filePath, ":", _err) + log.Println("_ERROR\tfmd:WriteFMDToHTMLString:ReadFile:", filePath, ":", _err) } _l := MakeLexer("RenderLexer", _fileBytes) diff --git a/src/fmd/fmd_test.go b/src/fmd/fmd_test.go @@ -5,8 +5,8 @@ import ( ) func TestFMD(t *testing.T) { - _path := ("/home/weetat/MIKI/data/ents/home.fmd") - RenderFMD(_path) + // _path := ("/home/weetat/MIKI/data/ents/home.fmd") + // WriteFMDtoHTMLFile(_path) // t.Log("Path:", _path) // _input, _err := os.ReadFile(_path) // if _err != nil { diff --git a/src/fmd/parser.go b/src/fmd/parser.go @@ -113,7 +113,7 @@ func (p *parser) consume(t tokenType) token { p.pos++ return token } - panic(fmt.Sprintf("__PANIC\tInvalid token:%v", t)) + panic(fmt.Sprintf("__PANIC\tfmd:parser:Invalid token:%v", t)) } func (p *parser) current() token { diff --git a/src/fmd/temp.html b/src/fmd/temp.html @@ -1,12 +0,0 @@ -<h1> <b>Welcome</b> To My <i>Wiki</i> </h1> - -This is the landing page for my wiki. - -<div class="__mcol"> - <div> - <img src="data/logo.png" alt="logo.png"></img> - </div> - <div> - This is the content of the other column. - </div> -</div> -\ No newline at end of file diff --git a/src/network/network.go b/src/network/network.go @@ -26,7 +26,7 @@ func handlePageDefault(w http.ResponseWriter, r *http.Request) { // Produce URL path to directory relation. _r, _err := mfs.MakeDirectorySig(filepath.Join(mfs.Dirs.WebDirectory, r.URL.String()), 0, mfs.FilePatternHTML) if _err != nil { - log.Printf("_ERROR\thandlePageDefault(\"/\"):%s\n", _err) + log.Printf("_ERROR\tnetwork:handlePageDefault(\"/\"):%s\n", _err) http.NotFound(w, r) return } @@ -34,25 +34,26 @@ func handlePageDefault(w http.ResponseWriter, r *http.Request) { // Collect HTML template files from directory. _rPkg, _err := mfs.MakeDirectoryPkg(_r) if _err != nil { - log.Printf("_ERROR\thandlePageDefault(\"/\"):%s\n", _err) + log.Printf("_ERROR\tnetwork:handlePageDefault(\"/\"):%s\n", _err) http.NotFound(w, r) return } + // Add 'global' file dependencies. _rPkg.DependencyFiles = append(_rPkg.DependencyFiles, mfs.GlobalPkg.DependencyFiles...) - // log.Printf("INFO\thandleDefaultPage:rPkg:%v", _rPkg) - + // Create template from package. _tmpl, _err := template.ParseFiles(_rPkg.DependencyFiles...) if _err != nil { - log.Printf("_ERROR\thandlePageDefault(\"/\"):%s\n", _err) - http.Error(w, "_ERROR:handlePageDefault(\"/\"):template.ParseFiles", 500) + log.Printf("_ERROR\tnetwork:handlePageDefault(\"/\"):%s\n", _err) + http.Error(w, "_ERROR:network:handlePageDefault(\"/\"):template.ParseFiles", 500) return } + // Render template. if _err = _tmpl.ExecuteTemplate(w, "index.html", _rPkg.DependencyData); _err != nil { - log.Printf("_ERROR\thandlePageDefault(\"/\"):%s\n", _err) - http.Error(w, "_ERROR:handlePageDefault(\"/\"):template.ExecuteTemplate", 500) + log.Printf("_ERROR\tnetwork:handlePageDefault(\"/\"):%s\n", _err) + http.Error(w, "_ERROR:network:handlePageDefault(\"/\"):template.ExecuteTemplate", 500) return } @@ -62,9 +63,10 @@ func handlePageDefault(w http.ResponseWriter, r *http.Request) { func Init() { //// GET SERVER INFO + _siData, _err := os.ReadFile("sys/config.json") if _err != nil { - log.Panicln("__PANIC\tos.ReadFile:config.json:" + _err.Error()) + log.Panicln("__PANIC\tnetwork:Init:os.ReadFile:config.json:" + _err.Error()) return } @@ -109,23 +111,19 @@ func Init() { mux.Handle("/web/", http.StripPrefix("/web/", http.FileServer(http.Dir(mfs.Dirs.WebDirectory)))) mux.HandleFunc("/favicon.ico", func(w http.ResponseWriter, r *http.Request) { - // log.Printf("CALL\tmain:mux.HandleFunc:%s\n", r.URL) http.ServeFile(w, r, filepath.Join(mfs.Dirs.WebDirectory, "/global/favicon.ico")) - // log.Printf("DONE\tmain:mux.HandleFunc:%s\n", r.URL) }) mux.HandleFunc("/home", handlePageDefault) mux.HandleFunc("/edit", handlePageDefault) mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { - // log.Printf("CALL\tmain:mux.HandleFunc:%s\n", r.URL) if r.URL.Path == "/" { http.Redirect(w, r, "/home", http.StatusMovedPermanently) return } else { http.NotFound(w, r) } - // log.Printf("DONE\tmain:mux.HandleFunc:%s\n", r.URL) }) }