From c45471b6772110a7640febbd05999d27ff6e2805 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Thu, 7 Nov 2024 17:22:34 -0500 Subject: [PATCH 1/9] feat: custom stop words in config --- internal/config/config.go | 28 ++++++++++++++-------------- internal/linking/ngrams/stopwords.go | 14 ++++++++++++++ main.go | 17 ++++++++--------- pkg/plugins/plugin.go | 11 ++++------- 4 files changed, 40 insertions(+), 30 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index f3f63e6..760df1e 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -8,7 +8,7 @@ import ( "github.com/BurntSushi/toml" ) -var config OolongConfig +var cfg OolongConfig type OolongConfig struct { NotesDirPaths []string `toml:"note_directories"` @@ -16,21 +16,21 @@ type OolongConfig struct { AllowedExtensions []string `toml:"allowed_extensions"` PluginPaths []string `toml:"plugin_paths"` IgnoreDirectories []string `toml:"ignored_directories"` - StopWords []string `toml:"stopwords"` + StopWords []string `toml:"stop_words"` } -func Config() *OolongConfig { return &config } +func Config() *OolongConfig { return &cfg } -func NotesDirPaths() []string { return config.NotesDirPaths } -func NGramRange() []int { return config.NGramRange } -func AllowedExtensions() []string { return config.AllowedExtensions } -func PluginPaths() []string { return config.PluginPaths } -func IgnoredDirectories() []string { return config.IgnoreDirectories } -func StopWords() []string { return config.StopWords } +func NotesDirPaths() []string { return cfg.NotesDirPaths } +func NGramRange() []int { return cfg.NGramRange } +func AllowedExtensions() []string { return cfg.AllowedExtensions } +func PluginPaths() []string { return cfg.PluginPaths } +func IgnoredDirectories() []string { return cfg.IgnoreDirectories } +func StopWords() []string { return cfg.StopWords } // TODO: file watcher for config file, reload on change -func Setup(configPath string) (OolongConfig, error) { +func Setup(configPath string) error { var err error configPath, err = expand(configPath) if err != nil { @@ -42,20 +42,20 @@ func Setup(configPath string) (OolongConfig, error) { panic(err) } - err = toml.Unmarshal(contents, &config) + err = toml.Unmarshal(contents, &cfg) if err != nil { panic(err) } - for i, dir := range config.NotesDirPaths { + for i, dir := range cfg.NotesDirPaths { d, err := expand(dir) if err != nil { panic(err) } - config.NotesDirPaths[i] = d + cfg.NotesDirPaths[i] = d } - return config, nil + return nil } func expand(path string) (string, error) { diff --git a/internal/linking/ngrams/stopwords.go b/internal/linking/ngrams/stopwords.go index 96f6252..f8284bc 100644 --- a/internal/linking/ngrams/stopwords.go +++ b/internal/linking/ngrams/stopwords.go @@ -1,5 +1,19 @@ package ngrams +import ( + "fmt" + + "github.com/oolong-sh/oolong/internal/config" +) + var stopWords = []string{ "a", "about", "above", "across", "after", "afterwards", "again", "against", "all", "almost", "alone", "along", "already", "also", "although", "always", "am", "among", "amongst", "amoungst", "amount", "an", "and", "another", "any", "anyhow", "anyone", "anything", "anyway", "anywhere", "are", "around", "as", "at", "back", "be", "became", "because", "become", "becomes", "becoming", "been", "before", "beforehand", "behind", "being", "below", "beside", "besides", "between", "beyond", "bill", "both", "bottom", "but", "by", "call", "can", "cannot", "cant", "co", "computer", "con", "could", "couldnt", "cry", "de", "describe", "detail", "did", "didn", "do", "does", "doesn", "doing", "don", "done", "down", "due", "during", "each", "eg", "eight", "either", "eleven", "else", "elsewhere", "empty", "enough", "etc", "even", "ever", "every", "everyone", "everything", "everywhere", "except", "few", "fifteen", "fify", "fill", "find", "fire", "first", "five", "for", "former", "formerly", "forty", "found", "four", "from", "front", "full", "further", "get", "give", "go", "had", "has", "hasnt", "have", "he", "hence", "her", "here", "hereafter", "hereby", "herein", "hereupon", "hers", "herself", "him", "himself", "his", "how", "however", "hundred", "i", "ie", "if", "in", "inc", "indeed", "interest", "into", "is", "it", "its", "itself", "just", "keep", "kg", "km", "last", "latter", "latterly", "least", "less", "ltd", "made", "make", "many", "may", "me", "meanwhile", "might", "mill", "mine", "more", "moreover", "most", "mostly", "move", "much", "must", "my", "myself", "name", "namely", "neither", "never", "nevertheless", "next", "nine", "no", "nobody", "none", "noone", "nor", "not", "nothing", "now", "nowhere", "of", "off", "often", "on", "once", "one", "only", "onto", "or", "other", "others", "otherwise", "our", "ours", "ourselves", "out", "over", "own", "part", "per", "perhaps", "please", "put", "quite", "rather", "re", "really", "regarding", "same", "say", "see", "seem", "seemed", "seeming", "seems", "serious", "several", "she", "should", "show", "side", "since", "sincere", "six", "sixty", "so", "some", "somehow", "someone", "something", "sometime", "sometimes", "somewhere", "still", "such", "system", "take", "ten", "than", "that", "the", "their", "them", "themselves", "then", "thence", "there", "thereafter", "thereby", "therefore", "therein", "thereupon", "these", "they", "thick", "thin", "third", "this", "those", "though", "three", "through", "throughout", "thru", "thus", "to", "together", "too", "top", "toward", "towards", "twelve", "twenty", "two", "un", "under", "unless", "until", "up", "upon", "us", "used", "using", "various", "very", "via", "was", "we", "well", "were", "what", "whatever", "when", "whence", "whenever", "where", "whereafter", "whereas", "whereby", "wherein", "whereupon", "wherever", "whether", "which", "while", "whither", "who", "whoever", "whole", "whom", "whose", "why", "will", "with", "within", "without", "would", "yet", "you", "your", "yours", "yourself", "yourselves", } + +// DOC: +func MergeStopWords() { + if config.StopWords() != nil { + fmt.Println(config.StopWords()) + stopWords = append(stopWords, config.StopWords()...) + } +} diff --git a/main.go b/main.go index 2aae615..46deac0 100644 --- a/main.go +++ b/main.go @@ -2,11 +2,11 @@ package main import ( "flag" - "fmt" "github.com/oolong-sh/oolong/internal/config" "github.com/oolong-sh/oolong/internal/daemon" "github.com/oolong-sh/oolong/internal/documents" + "github.com/oolong-sh/oolong/internal/linking/ngrams" "github.com/oolong-sh/oolong/internal/state" ) @@ -14,23 +14,22 @@ var daemonFlag = flag.Bool("no-daemon", false, "Run Oolong in no-daemon mode (no func main() { // read in config - cfg, err := config.Setup("~/.config/oolong.toml") - if err != nil { - fmt.Println(err) - return + if err := config.Setup("~/.config/oolong.toml"); err != nil { + panic(err) } - fmt.Println(cfg.PluginPaths) + + // merge stop words from config + ngrams.MergeStopWords() // initialize state state.InitState() // read notes directories - err = documents.ReadNotesDirs() - if err != nil { + if err := documents.ReadNotesDirs(); err != nil { panic(err) } - // go plugins.InitPlugins(&cfg) + // go plugins.InitPlugins() // run daemon if --no-daemon flag is not passed flag.Parse() diff --git a/pkg/plugins/plugin.go b/pkg/plugins/plugin.go index c517391..5c71572 100644 --- a/pkg/plugins/plugin.go +++ b/pkg/plugins/plugin.go @@ -7,7 +7,7 @@ import ( "github.com/oolong-sh/oolong/internal/config" ) -func InitPlugins(cfg *config.OolongConfig) { +func InitPlugins() { pm, err := NewPluginManager() if err != nil { fmt.Println("Error initializing plugin manager:", err) @@ -15,14 +15,12 @@ func InitPlugins(cfg *config.OolongConfig) { } defer pm.LuaState.Close() - pm.LoadPlugins(cfg.PluginPaths) - if err != nil { + if err := pm.LoadPlugins(config.PluginPaths()); err != nil { fmt.Println("Error loading plugins:", err) return } - err = pm.TriggerEvent("dailyNoteEvent") - if err != nil { + if err := pm.TriggerEvent("dailyNoteEvent"); err != nil { fmt.Println("Error triggering daily note event:", err) return } @@ -30,8 +28,7 @@ func InitPlugins(cfg *config.OolongConfig) { // start an event loop in a separate goroutine (act as a daemon) go pm.StartEventLoop() - err = pm.TriggerEvent("customEvent", "example data") - if err != nil { + if err := pm.TriggerEvent("customEvent", "example data"); err != nil { fmt.Println("Error triggering event:", err) } From 1dd0b2fe01aaaa85031c72405a0e72f003d2a065 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Thu, 7 Nov 2024 22:21:09 -0500 Subject: [PATCH 2/9] feat: wip api endpoints --- internal/api/api_utils.go | 18 ++++ internal/api/endpoints.go | 31 +++++++ internal/api/graph_handlers.go | 19 ++++ internal/api/note_handlers.go | 96 +++++++++++++++++++++ internal/daemon/daemon.go | 9 +- internal/daemon/watcher.go | 2 + {pkg => internal}/graph/graph.go | 6 +- {pkg => internal}/keywords/keywords.go | 0 internal/linking/lexer/lexer_test.go | 4 +- {pkg => internal}/notes/notes.go | 0 {pkg => internal}/plugins/plugin.go | 0 {pkg => internal}/plugins/plugin_manager.go | 0 internal/state/state.go | 7 +- 13 files changed, 182 insertions(+), 10 deletions(-) create mode 100644 internal/api/api_utils.go create mode 100644 internal/api/endpoints.go create mode 100644 internal/api/graph_handlers.go create mode 100644 internal/api/note_handlers.go rename {pkg => internal}/graph/graph.go (89%) rename {pkg => internal}/keywords/keywords.go (100%) rename {pkg => internal}/notes/notes.go (100%) rename {pkg => internal}/plugins/plugin.go (100%) rename {pkg => internal}/plugins/plugin_manager.go (100%) diff --git a/internal/api/api_utils.go b/internal/api/api_utils.go new file mode 100644 index 0000000..6eb987d --- /dev/null +++ b/internal/api/api_utils.go @@ -0,0 +1,18 @@ +package api + +import "os" + +// exists returns whether the given file or directory exists +func exists(path string) (bool, error) { + _, err := os.Stat(path) + + if err == nil { + return true, nil + } + + if os.IsNotExist(err) { + return false, nil + } + + return false, err +} diff --git a/internal/api/endpoints.go b/internal/api/endpoints.go new file mode 100644 index 0000000..c1cde42 --- /dev/null +++ b/internal/api/endpoints.go @@ -0,0 +1,31 @@ +package api + +import ( + "log" + "net/http" +) + +// DOC: +func SpawnServer() { + mux := http.NewServeMux() + + // graph endpoints + mux.HandleFunc("GET /graph", handleGetGraph) + + // note endpoints + mux.HandleFunc("GET /notes", handleGetNotes) + mux.HandleFunc("GET /note", handleGetNote) + mux.HandleFunc("POST /note", handleCreateNote) + mux.HandleFunc("PUT /note", handleUpdateNote) + mux.HandleFunc("DELETE /note", handleDeleteNote) + + // keyword endpoints? + + // plugin endpoints? (probably not these outside of official ones) + + // start server + log.Println("Starting server on :11975...") + if err := http.ListenAndServe(":11975", mux); err != nil { + log.Fatalf("Server failed to start: %v", err) + } +} diff --git a/internal/api/graph_handlers.go b/internal/api/graph_handlers.go new file mode 100644 index 0000000..98961ec --- /dev/null +++ b/internal/api/graph_handlers.go @@ -0,0 +1,19 @@ +package api + +import ( + "encoding/json" + "net/http" +) + +func handleGetGraph(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + + // TODO: finish implementation + // data, err := graph.SerializeGraph() + data := "" + + if err := json.NewEncoder(w).Encode(data); err != nil { + http.Error(w, "Error encoding graph data", 400) + } + +} diff --git a/internal/api/note_handlers.go b/internal/api/note_handlers.go new file mode 100644 index 0000000..2e458a6 --- /dev/null +++ b/internal/api/note_handlers.go @@ -0,0 +1,96 @@ +package api + +import ( + "encoding/json" + "log" + "net/http" + "os" + + "github.com/oolong-sh/oolong/internal/state" +) + +// 'GET /notes' endpoint handler returns all available note paths +func handleGetNotes(w http.ResponseWriter, r *http.Request) { + log.Println("Request received:", r.Method, r.URL, r.Host) + + data := make([]string, len(state.State().Documents)) + for k := range state.State().Documents { + data = append(data, k) + } + + w.Header().Set("Content-Type", "application/json") + json.NewEncoder(w).Encode(data) +} + +// DOC: +func handleGetNote(w http.ResponseWriter, r *http.Request) { + log.Println("Request received:", r.Method, r.URL, r.Host) + + path := r.URL.Query().Get("path") + if path == "" { + http.Error(w, "Path parameter not specified ", http.StatusBadRequest) + return + } + + // read file contents + b, err := os.ReadFile(path) + if err != nil { + log.Println(err) + http.Error(w, "Could not read file '"+path+"'", 500) + return + } + + // write file contents into response body + w.Header().Set("Content-Type", "application/json") + if err := json.NewEncoder(w).Encode(string(b)); err != nil { + log.Println(err) + http.Error(w, "Failed to encode file contents as JSON.\n", 500) + } +} + +// DOC: +func handleCreateNote(w http.ResponseWriter, r *http.Request) { + log.Println("Request received:", r.Method, r.URL, r.Host) + + path := r.URL.Query().Get("path") + if path == "" { + http.Error(w, "Path parameter not specified ", http.StatusBadRequest) + return + } + + // check if path before file exists, then check if file exists + if e, err := exists(path); err != nil { + log.Println(err) + http.Error(w, "Error checking path", 500) + return + } else if e { + log.Printf("File %s already exists.\n", path) + http.Error(w, "Note file already exists", 500) + return + } + // TODO: create directory case? + // - this will also require adding an additional watcher + + _, err := os.Create(path) + if err != nil { + log.Println(err) + http.Error(w, "Failed to create note file", 500) + return + } +} + +// DOC: +func handleUpdateNote(w http.ResponseWriter, r *http.Request) { + // TODO: allow writing notes + + // NOTE: DO NOT CALL STATE UPDATE HERE, LET WATCHER HANDLE IT + // - this function only needs to write to a file in the watched locations +} + +// DOC: +func handleDeleteNote(w http.ResponseWriter, r *http.Request) { + // TODO: allow writing notes + + // NOTE: this function may need to call the update function due to files no longer existing + // - check this case in state, this may require substantial logic missing there +} diff --git a/internal/daemon/daemon.go b/internal/daemon/daemon.go index 4b92e9a..0ffd02d 100644 --- a/internal/daemon/daemon.go +++ b/internal/daemon/daemon.go @@ -1,11 +1,18 @@ package daemon -import "github.com/oolong-sh/oolong/internal/config" +import ( + "github.com/oolong-sh/oolong/internal/api" + "github.com/oolong-sh/oolong/internal/config" +) // Launch perpetually running watchers and run application in the background as a daemon func Run() { + // run file watcher go runNotesDirsWatcher(config.NotesDirPaths()...) + // run api server + go api.SpawnServer() + // run forever <-make(chan struct{}) } diff --git a/internal/daemon/watcher.go b/internal/daemon/watcher.go index 2e09261..5b22699 100644 --- a/internal/daemon/watcher.go +++ b/internal/daemon/watcher.go @@ -60,6 +60,8 @@ func runNotesDirsWatcher(dirs ...string) error { } // log.Println("Event:", event) + // TODO: add new watcher in cases where new directories are created + if event.Has(fsnotify.Write) { log.Println("Modified file:", event.Name) diff --git a/pkg/graph/graph.go b/internal/graph/graph.go similarity index 89% rename from pkg/graph/graph.go rename to internal/graph/graph.go index f9c6610..a437056 100644 --- a/pkg/graph/graph.go +++ b/internal/graph/graph.go @@ -4,8 +4,8 @@ import ( "encoding/json" "path/filepath" - "github.com/oolong-sh/oolong/pkg/keywords" - "github.com/oolong-sh/oolong/pkg/notes" + "github.com/oolong-sh/oolong/internal/keywords" + "github.com/oolong-sh/oolong/internal/notes" ) type NodeJSON struct { @@ -52,7 +52,7 @@ func SerializeGraph(keywordMap map[string]keywords.Keyword, notes []notes.Note, for _, note := range notes { // Add Note node noteID := note.Path - noteName := filepath.Base(note.Path) // /home/patrick/notes/home/blogs/bayes.md -> bayes.md + noteName := filepath.Base(note.Path) nodes = append(nodes, NodeJSON{ ID: noteID, Name: noteName, diff --git a/pkg/keywords/keywords.go b/internal/keywords/keywords.go similarity index 100% rename from pkg/keywords/keywords.go rename to internal/keywords/keywords.go diff --git a/internal/linking/lexer/lexer_test.go b/internal/linking/lexer/lexer_test.go index df19185..ca685ba 100644 --- a/internal/linking/lexer/lexer_test.go +++ b/internal/linking/lexer/lexer_test.go @@ -14,9 +14,7 @@ import ( var cfg config.OolongConfig func init() { - var err error - cfg, err = config.Setup("../../../examples/oolong.toml") - if err != nil { + if err := config.Setup("../../../examples/oolong.toml"); err != nil { panic(err) } } diff --git a/pkg/notes/notes.go b/internal/notes/notes.go similarity index 100% rename from pkg/notes/notes.go rename to internal/notes/notes.go diff --git a/pkg/plugins/plugin.go b/internal/plugins/plugin.go similarity index 100% rename from pkg/plugins/plugin.go rename to internal/plugins/plugin.go diff --git a/pkg/plugins/plugin_manager.go b/internal/plugins/plugin_manager.go similarity index 100% rename from pkg/plugins/plugin_manager.go rename to internal/plugins/plugin_manager.go diff --git a/internal/state/state.go b/internal/state/state.go index 2092d44..a64977f 100644 --- a/internal/state/state.go +++ b/internal/state/state.go @@ -6,10 +6,10 @@ import ( "os" "github.com/oolong-sh/oolong/internal/documents" + "github.com/oolong-sh/oolong/internal/graph" + "github.com/oolong-sh/oolong/internal/keywords" "github.com/oolong-sh/oolong/internal/linking/ngrams" - "github.com/oolong-sh/oolong/pkg/graph" - "github.com/oolong-sh/oolong/pkg/keywords" - "github.com/oolong-sh/oolong/pkg/notes" + "github.com/oolong-sh/oolong/internal/notes" ) // application-wide persistent state of documents and ngrams @@ -36,6 +36,7 @@ func InitState() { } // Update application state information after file reads are performed +// FIX: this needs to lock state while running to ensure endpoints will work correctly func UpdateState(docs []*documents.Document) error { log.Println("Updating state and recalculating weights...") From fdcf6ce934848c93f9b9cf020adf5ce7c1b4f287 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Thu, 21 Nov 2024 17:27:43 -0500 Subject: [PATCH 3/9] feat: WIP locking of state for api (will likely change to channels in separate branch) --- internal/documents/corpus.go | 7 ++++- internal/documents/corpus_test.go | 27 ++++++++----------- internal/linking/ngrams/stopwords.go | 3 --- internal/plugins/plugin.go | 10 +++---- internal/state/state.go | 39 ++++++++++++++++++++-------- 5 files changed, 50 insertions(+), 36 deletions(-) diff --git a/internal/documents/corpus.go b/internal/documents/corpus.go index 15007ae..2f95447 100644 --- a/internal/documents/corpus.go +++ b/internal/documents/corpus.go @@ -1,6 +1,7 @@ package documents import ( + "errors" "io/fs" "log" "path/filepath" @@ -10,7 +11,7 @@ import ( "github.com/oolong-sh/oolong/internal/config" ) -// State updater function is dependency injected from state to avoid circular dependency +// State updater function depends on injected function from state to avoid circular dependency var UpdateState func([]*Document) error // DOC: meant to be called with watcher @@ -64,6 +65,10 @@ func ReadNotesDirs() error { docs = append(docs, readHandler(paths...)...) } + if len(docs) == 0 { + return errors.New("No documents found in NotesDirPaths.") + } + // merge maps and calculate weights err := UpdateState(docs) if err != nil { diff --git a/internal/documents/corpus_test.go b/internal/documents/corpus_test.go index 0b76e9d..ff5d1b1 100644 --- a/internal/documents/corpus_test.go +++ b/internal/documents/corpus_test.go @@ -15,7 +15,7 @@ var cfg = config.OolongConfig{ // NotesDirPaths: []string{"~/notes"}, NotesDirPaths: []string{"../../examples/data"}, NGramRange: []int{1, 2, 3}, - AllowedExtensions: []string{".md", ".tex", ".typ"}, + AllowedExtensions: []string{".md", ".tex", ".typ", ".txt"}, PluginPaths: []string{}, IgnoreDirectories: []string{".templates", ".git"}, } @@ -25,25 +25,20 @@ func init() { } func TestReadNotesDirs(t *testing.T) { - s := state.State() + conf := config.Config() + conf.NotesDirPaths = cfg.NotesDirPaths + conf.NGramRange = cfg.NGramRange + conf.AllowedExtensions = cfg.AllowedExtensions + conf.PluginPaths = cfg.PluginPaths + conf.IgnoreDirectories = cfg.IgnoreDirectories + // TODO: actual tests with an example data directory + fmt.Println("reading?? -- gets lock") if err := documents.ReadNotesDirs(); err != nil { t.Fatalf("Failed to read notes directories: %v\n", err) } - - // write out tokens - // b := []byte{} - // for _, d := range s.Documents { - // for _, t := range d.tokens { - // if t.Value == lexer.BreakToken { - // continue - // } - // b = append(b, []byte(fmt.Sprintf("%s, %s, %d\n", t.Lemma, t.Value, t.Zone))...) - // } - // } - // if err := os.WriteFile("./tokens.txt", b, 0666); err != nil { - // t.Fatalf("Failed to write tokens: %v\n", err) - // } + fmt.Println("finished reading -- getting read lock") + s := state.State() b := append([]byte{}, []byte("ngram,weight,count\n")...) for _, d := range s.Documents { diff --git a/internal/linking/ngrams/stopwords.go b/internal/linking/ngrams/stopwords.go index f8284bc..c821a59 100644 --- a/internal/linking/ngrams/stopwords.go +++ b/internal/linking/ngrams/stopwords.go @@ -1,8 +1,6 @@ package ngrams import ( - "fmt" - "github.com/oolong-sh/oolong/internal/config" ) @@ -13,7 +11,6 @@ var stopWords = []string{ // DOC: func MergeStopWords() { if config.StopWords() != nil { - fmt.Println(config.StopWords()) stopWords = append(stopWords, config.StopWords()...) } } diff --git a/internal/plugins/plugin.go b/internal/plugins/plugin.go index 5c71572..da54b21 100644 --- a/internal/plugins/plugin.go +++ b/internal/plugins/plugin.go @@ -1,7 +1,7 @@ package plugins import ( - "fmt" + "log" "time" "github.com/oolong-sh/oolong/internal/config" @@ -10,18 +10,18 @@ import ( func InitPlugins() { pm, err := NewPluginManager() if err != nil { - fmt.Println("Error initializing plugin manager:", err) + log.Println("Error initializing plugin manager:", err) return } defer pm.LuaState.Close() if err := pm.LoadPlugins(config.PluginPaths()); err != nil { - fmt.Println("Error loading plugins:", err) + log.Println("Error loading plugins:", err) return } if err := pm.TriggerEvent("dailyNoteEvent"); err != nil { - fmt.Println("Error triggering daily note event:", err) + log.Println("Error triggering daily note event:", err) return } @@ -29,7 +29,7 @@ func InitPlugins() { go pm.StartEventLoop() if err := pm.TriggerEvent("customEvent", "example data"); err != nil { - fmt.Println("Error triggering event:", err) + log.Println("Error triggering event:", err) } time.Sleep(2 * time.Second) diff --git a/internal/state/state.go b/internal/state/state.go index a64977f..a7a2ade 100644 --- a/internal/state/state.go +++ b/internal/state/state.go @@ -4,6 +4,7 @@ import ( "fmt" "log" "os" + "sync" "github.com/oolong-sh/oolong/internal/documents" "github.com/oolong-sh/oolong/internal/graph" @@ -13,7 +14,14 @@ import ( ) // application-wide persistent state of documents and ngrams -var state OolongState +// var state OolongState + +var mgr StateManager + +type StateManager struct { + state OolongState + m sync.RWMutex +} type OolongState struct { Documents map[string]*documents.Document @@ -21,14 +29,20 @@ type OolongState struct { } // State getter -func State() OolongState { return state } +func State() OolongState { + mgr.m.RLock() + defer mgr.m.RUnlock() + return mgr.state +} // Initialize oolong state variables and inject state updater function into documents func InitState() { // instantiate persistent state - state = OolongState{ - Documents: map[string]*documents.Document{}, - NGrams: map[string]*ngrams.NGram{}, + mgr = StateManager{ + state: OolongState{ + Documents: map[string]*documents.Document{}, + NGrams: map[string]*ngrams.NGram{}, + }, } // dependency injection of state updater function @@ -37,28 +51,31 @@ func InitState() { // Update application state information after file reads are performed // FIX: this needs to lock state while running to ensure endpoints will work correctly +// - or use channels and statemanager type func UpdateState(docs []*documents.Document) error { + mgr.m.Lock() + defer mgr.m.Unlock() log.Println("Updating state and recalculating weights...") // update state documents for _, doc := range docs { - state.Documents[doc.Path] = doc + mgr.state.Documents[doc.Path] = doc } // merge resulting ngram maps - for _, d := range state.Documents { - ngrams.Merge(state.NGrams, d.NGrams) + for _, d := range mgr.state.Documents { + ngrams.Merge(mgr.state.NGrams, d.NGrams) } // calculate weights - ngrams.CalcWeights(state.NGrams, len(state.Documents)) + ngrams.CalcWeights(mgr.state.NGrams, len(mgr.state.Documents)) log.Println("Done calculating weights.") // update document weights after all weights are calculated log.Println("Updating document weights...") - for ng, ngram := range state.NGrams { + for ng, ngram := range mgr.state.NGrams { for path, nginfo := range ngram.Documents() { - state.Documents[path].Weights[ng] = nginfo.DocumentWeight + mgr.state.Documents[path].Weights[ng] = nginfo.DocumentWeight } } log.Println("Done updating document weights.") From 208e2d377703f1d9e8d15aef7b80c0b1c02fbbee Mon Sep 17 00:00:00 2001 From: ptdewey Date: Fri, 22 Nov 2024 08:42:37 -0500 Subject: [PATCH 4/9] feat(wip): api and graph handlers --- graph-2d.html | 28 ++++++++++++++++++++++ graph-3d.html | 35 ++++++++++++++++++++++++++++ index.html | 35 ++++++++++++++++++++++++++++ internal/api/graph_handlers.go | 3 ++- internal/api/note_handlers.go | 29 ++++++++++++++++++++--- internal/graph/graph.go | 2 +- internal/linking/ngrams/stopwords.go | 5 +--- internal/plugins/plugin.go | 10 ++++---- 8 files changed, 133 insertions(+), 14 deletions(-) create mode 100644 graph-2d.html create mode 100644 graph-3d.html create mode 100644 index.html diff --git a/graph-2d.html b/graph-2d.html new file mode 100644 index 0000000..ccf1814 --- /dev/null +++ b/graph-2d.html @@ -0,0 +1,28 @@ + + + + + + + + +
+ + + diff --git a/graph-3d.html b/graph-3d.html new file mode 100644 index 0000000..661df53 --- /dev/null +++ b/graph-3d.html @@ -0,0 +1,35 @@ + + + + + + + + +
+ + + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..661df53 --- /dev/null +++ b/index.html @@ -0,0 +1,35 @@ + + + + + + + + +
+ + + + diff --git a/internal/api/graph_handlers.go b/internal/api/graph_handlers.go index 98961ec..6f5aa28 100644 --- a/internal/api/graph_handlers.go +++ b/internal/api/graph_handlers.go @@ -8,6 +8,8 @@ import ( func handleGetGraph(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") + // TODO: server up graph json directly rather than writing to file + // TODO: finish implementation // data, err := graph.SerializeGraph() data := "" @@ -15,5 +17,4 @@ func handleGetGraph(w http.ResponseWriter, r *http.Request) { if err := json.NewEncoder(w).Encode(data); err != nil { http.Error(w, "Error encoding graph data", 400) } - } diff --git a/internal/api/note_handlers.go b/internal/api/note_handlers.go index 2e458a6..8352697 100644 --- a/internal/api/note_handlers.go +++ b/internal/api/note_handlers.go @@ -22,7 +22,7 @@ func handleGetNotes(w http.ResponseWriter, r *http.Request) { json.NewEncoder(w).Encode(data) } -// DOC: +// 'GET /note/{path}' endpoint handler gets note contents corresponding to input path func handleGetNote(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) @@ -48,7 +48,7 @@ func handleGetNote(w http.ResponseWriter, r *http.Request) { } } -// DOC: +// 'POST /note/{path}' endpoint handler creates note contents corresponding to input path func handleCreateNote(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) @@ -89,7 +89,30 @@ func handleUpdateNote(w http.ResponseWriter, r *http.Request) { // DOC: func handleDeleteNote(w http.ResponseWriter, r *http.Request) { - // TODO: allow writing notes + log.Println("Request received:", r.Method, r.URL, r.Host) + + path := r.URL.Query().Get("path") + if path == "" { + http.Error(w, "Path parameter not specified ", http.StatusBadRequest) + return + } + + // check if path before file exists, then check if file exists + if e, err := exists(path); err != nil { + log.Println(err) + http.Error(w, "Error checking path", 500) + return + } else if !e { + log.Printf("File %s does not exists.\n", path) + http.Error(w, "File does not exist", 500) + return + } + + if err := os.Remove(path); err != nil { + log.Println("Failed to delete file", err) + http.Error(w, "Failed to remove file", 500) + return + } // NOTE: this function may need to call the update function due to files no longer existing // - check this case in state, this may require substantial logic missing there diff --git a/internal/graph/graph.go b/internal/graph/graph.go index 504fe91..6ea2420 100644 --- a/internal/graph/graph.go +++ b/internal/graph/graph.go @@ -34,7 +34,7 @@ func clamp(value, min, max float64) float64 { return value } -const NOTE_NODE_VAL = 50 +const NOTE_NODE_VAL = 10 func SerializeGraph(keywordMap map[string]keywords.Keyword, notes []notes.Note, lowerBound, upperBound float64) ([]byte, error) { nodes := []NodeJSON{} diff --git a/internal/linking/ngrams/stopwords.go b/internal/linking/ngrams/stopwords.go index f8284bc..1075a28 100644 --- a/internal/linking/ngrams/stopwords.go +++ b/internal/linking/ngrams/stopwords.go @@ -1,8 +1,6 @@ package ngrams import ( - "fmt" - "github.com/oolong-sh/oolong/internal/config" ) @@ -10,10 +8,9 @@ var stopWords = []string{ "a", "about", "above", "across", "after", "afterwards", "again", "against", "all", "almost", "alone", "along", "already", "also", "although", "always", "am", "among", "amongst", "amoungst", "amount", "an", "and", "another", "any", "anyhow", "anyone", "anything", "anyway", "anywhere", "are", "around", "as", "at", "back", "be", "became", "because", "become", "becomes", "becoming", "been", "before", "beforehand", "behind", "being", "below", "beside", "besides", "between", "beyond", "bill", "both", "bottom", "but", "by", "call", "can", "cannot", "cant", "co", "computer", "con", "could", "couldnt", "cry", "de", "describe", "detail", "did", "didn", "do", "does", "doesn", "doing", "don", "done", "down", "due", "during", "each", "eg", "eight", "either", "eleven", "else", "elsewhere", "empty", "enough", "etc", "even", "ever", "every", "everyone", "everything", "everywhere", "except", "few", "fifteen", "fify", "fill", "find", "fire", "first", "five", "for", "former", "formerly", "forty", "found", "four", "from", "front", "full", "further", "get", "give", "go", "had", "has", "hasnt", "have", "he", "hence", "her", "here", "hereafter", "hereby", "herein", "hereupon", "hers", "herself", "him", "himself", "his", "how", "however", "hundred", "i", "ie", "if", "in", "inc", "indeed", "interest", "into", "is", "it", "its", "itself", "just", "keep", "kg", "km", "last", "latter", "latterly", "least", "less", "ltd", "made", "make", "many", "may", "me", "meanwhile", "might", "mill", "mine", "more", "moreover", "most", "mostly", "move", "much", "must", "my", "myself", "name", "namely", "neither", "never", "nevertheless", "next", "nine", "no", "nobody", "none", "noone", "nor", "not", "nothing", "now", "nowhere", "of", "off", "often", "on", "once", "one", "only", "onto", "or", "other", "others", "otherwise", "our", "ours", "ourselves", "out", "over", "own", "part", "per", "perhaps", "please", "put", "quite", "rather", "re", "really", "regarding", "same", "say", "see", "seem", "seemed", "seeming", "seems", "serious", "several", "she", "should", "show", "side", "since", "sincere", "six", "sixty", "so", "some", "somehow", "someone", "something", "sometime", "sometimes", "somewhere", "still", "such", "system", "take", "ten", "than", "that", "the", "their", "them", "themselves", "then", "thence", "there", "thereafter", "thereby", "therefore", "therein", "thereupon", "these", "they", "thick", "thin", "third", "this", "those", "though", "three", "through", "throughout", "thru", "thus", "to", "together", "too", "top", "toward", "towards", "twelve", "twenty", "two", "un", "under", "unless", "until", "up", "upon", "us", "used", "using", "various", "very", "via", "was", "we", "well", "were", "what", "whatever", "when", "whence", "whenever", "where", "whereafter", "whereas", "whereby", "wherein", "whereupon", "wherever", "whether", "which", "while", "whither", "who", "whoever", "whole", "whom", "whose", "why", "will", "with", "within", "without", "would", "yet", "you", "your", "yours", "yourself", "yourselves", } -// DOC: +// Merge custom stop words from config with stop words slice func MergeStopWords() { if config.StopWords() != nil { - fmt.Println(config.StopWords()) stopWords = append(stopWords, config.StopWords()...) } } diff --git a/internal/plugins/plugin.go b/internal/plugins/plugin.go index 5c71572..da54b21 100644 --- a/internal/plugins/plugin.go +++ b/internal/plugins/plugin.go @@ -1,7 +1,7 @@ package plugins import ( - "fmt" + "log" "time" "github.com/oolong-sh/oolong/internal/config" @@ -10,18 +10,18 @@ import ( func InitPlugins() { pm, err := NewPluginManager() if err != nil { - fmt.Println("Error initializing plugin manager:", err) + log.Println("Error initializing plugin manager:", err) return } defer pm.LuaState.Close() if err := pm.LoadPlugins(config.PluginPaths()); err != nil { - fmt.Println("Error loading plugins:", err) + log.Println("Error loading plugins:", err) return } if err := pm.TriggerEvent("dailyNoteEvent"); err != nil { - fmt.Println("Error triggering daily note event:", err) + log.Println("Error triggering daily note event:", err) return } @@ -29,7 +29,7 @@ func InitPlugins() { go pm.StartEventLoop() if err := pm.TriggerEvent("customEvent", "example data"); err != nil { - fmt.Println("Error triggering event:", err) + log.Println("Error triggering event:", err) } time.Sleep(2 * time.Second) From 10c4dcf971a5dec94a192e6167dc0d647669e336 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Sat, 23 Nov 2024 11:27:45 -0500 Subject: [PATCH 5/9] feat: state handling with channels --- internal/api/note_handlers.go | 6 +- internal/keywords/keywords.go | 23 +----- internal/notes/notes.go | 23 +----- internal/state/state.go | 127 ++++++++++++++++++---------------- 4 files changed, 78 insertions(+), 101 deletions(-) diff --git a/internal/api/note_handlers.go b/internal/api/note_handlers.go index 8352697..13dd30e 100644 --- a/internal/api/note_handlers.go +++ b/internal/api/note_handlers.go @@ -13,8 +13,9 @@ import ( func handleGetNotes(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) - data := make([]string, len(state.State().Documents)) - for k := range state.State().Documents { + s := state.State() + data := make([]string, len(s.Documents)) + for k := range s.Documents { data = append(data, k) } @@ -23,6 +24,7 @@ func handleGetNotes(w http.ResponseWriter, r *http.Request) { } // 'GET /note/{path}' endpoint handler gets note contents corresponding to input path +// TODO: maybe change path to a request body/form item since it can have slashes func handleGetNote(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) diff --git a/internal/keywords/keywords.go b/internal/keywords/keywords.go index 3d2f002..4b42c30 100644 --- a/internal/keywords/keywords.go +++ b/internal/keywords/keywords.go @@ -2,42 +2,25 @@ package keywords import ( "encoding/json" - "os" "github.com/oolong-sh/oolong/internal/linking/ngrams" ) -var keywordsFile = "./oolong-keywords.json" - type Keyword struct { Keyword string `json:"keyword"` Weight float64 `json:"weight"` } // DOC: -func SerializeNGrams(ngmap map[string]*ngrams.NGram) error { +func SerializeNGrams(ngmap map[string]*ngrams.NGram) ([]byte, error) { keywords := NGramsToKeywords(ngmap) - err := serializeKeywords(keywords) - if err != nil { - return err - } - - return nil -} - -func serializeKeywords(keywords []Keyword) error { b, err := json.Marshal(keywords) if err != nil { - return err - } - - err = os.WriteFile(keywordsFile, b, 0644) - if err != nil { - return err + return nil, err } - return nil + return b, nil } // TODO: parameterize filtering threshold (maybe a percentage?) diff --git a/internal/notes/notes.go b/internal/notes/notes.go index 0f36e5d..24464f4 100644 --- a/internal/notes/notes.go +++ b/internal/notes/notes.go @@ -2,42 +2,25 @@ package notes import ( "encoding/json" - "os" "github.com/oolong-sh/oolong/internal/documents" ) -var notesFile = "./oolong-notes.json" - type Note struct { Path string `json:"path"` Weights map[string]float64 `json:"weights"` } // DOC: -func SerializeDocuments(documents map[string]*documents.Document) error { +func SerializeDocuments(documents map[string]*documents.Document) ([]byte, error) { notes := DocumentsToNotes(documents) - err := serializeNotes(notes) - if err != nil { - return err - } - - return nil -} - -func serializeNotes(notes []Note) error { b, err := json.Marshal(notes) if err != nil { - return err - } - - err = os.WriteFile(notesFile, b, 0644) - if err != nil { - return err + return nil, err } - return nil + return b, nil } // TODO: parameterize filtering threshold (maybe as a percentage?) diff --git a/internal/state/state.go b/internal/state/state.go index a7a2ade..86be0a9 100644 --- a/internal/state/state.go +++ b/internal/state/state.go @@ -4,7 +4,6 @@ import ( "fmt" "log" "os" - "sync" "github.com/oolong-sh/oolong/internal/documents" "github.com/oolong-sh/oolong/internal/graph" @@ -13,69 +12,85 @@ import ( "github.com/oolong-sh/oolong/internal/notes" ) -// application-wide persistent state of documents and ngrams -// var state OolongState - -var mgr StateManager - -type StateManager struct { - state OolongState - m sync.RWMutex -} - type OolongState struct { Documents map[string]*documents.Document NGrams map[string]*ngrams.NGram } -// State getter -func State() OolongState { - mgr.m.RLock() - defer mgr.m.RUnlock() - return mgr.state +type StateManager struct { + state OolongState + updates chan []*documents.Document + reads chan chan OolongState } -// Initialize oolong state variables and inject state updater function into documents +var s StateManager + func InitState() { - // instantiate persistent state - mgr = StateManager{ + s = StateManager{ state: OolongState{ Documents: map[string]*documents.Document{}, NGrams: map[string]*ngrams.NGram{}, }, + updates: make(chan []*documents.Document), + reads: make(chan chan OolongState), } - // dependency injection of state updater function + go s.run() + documents.UpdateState = UpdateState } -// Update application state information after file reads are performed -// FIX: this needs to lock state while running to ensure endpoints will work correctly -// - or use channels and statemanager type +func State() OolongState { + respChan := make(chan OolongState) + s.reads <- respChan + log.Println("State fetched.") + return <-respChan +} + +func (s *StateManager) run() { + for { + select { + case docs := <-s.updates: + s.updateState(docs) + case resp := <-s.reads: + resp <- s.state + } + } +} + func UpdateState(docs []*documents.Document) error { - mgr.m.Lock() - defer mgr.m.Unlock() + select { + case s.updates <- docs: + log.Println("Update request sent") + return nil + default: + log.Println("State update channel is full") + return fmt.Errorf("state update channel is full") + } +} + +func (s *StateManager) updateState(docs []*documents.Document) { log.Println("Updating state and recalculating weights...") - // update state documents + // Update state documents for _, doc := range docs { - mgr.state.Documents[doc.Path] = doc + s.state.Documents[doc.Path] = doc } - // merge resulting ngram maps - for _, d := range mgr.state.Documents { - ngrams.Merge(mgr.state.NGrams, d.NGrams) + // Merge resulting n-gram maps + for _, d := range s.state.Documents { + ngrams.Merge(s.state.NGrams, d.NGrams) } - // calculate weights - ngrams.CalcWeights(mgr.state.NGrams, len(mgr.state.Documents)) + // Calculate weights + ngrams.CalcWeights(s.state.NGrams, len(s.state.Documents)) log.Println("Done calculating weights.") - // update document weights after all weights are calculated + // Update document weights after all weights are calculated log.Println("Updating document weights...") - for ng, ngram := range mgr.state.NGrams { + for ng, ngram := range s.state.NGrams { for path, nginfo := range ngram.Documents() { - mgr.state.Documents[path].Weights[ng] = nginfo.DocumentWeight + s.state.Documents[path].Weights[ng] = nginfo.DocumentWeight } } log.Println("Done updating document weights.") @@ -83,39 +98,33 @@ func UpdateState(docs []*documents.Document) error { // // TEST: remove later // - state := State() - b := append([]byte{}, []byte("ngram,weight,count,ndocs\n")...) - mng := ngrams.FilterMeaningfulNGrams(state.NGrams, 2, int(float64(len(state.Documents))/1.5), 4.0) - for _, s := range mng { - b = append(b, []byte(fmt.Sprintf("%s,%f,%d,%d\n", s, state.NGrams[s].Weight(), state.NGrams[s].Count(), len(state.NGrams[s].Documents())))...) - } - if err := os.WriteFile("./meaningful-ngrams.csv", b, 0666); err != nil { - panic(err) - } + // Generate meaningful n-grams and write to a CSV (for testing/debugging) + // state := s.state // Snapshot of the current state + // b := append([]byte{}, []byte("ngram,weight,count,ndocs\n")...) + // mng := ngrams.FilterMeaningfulNGrams(state.NGrams, 2, int(float64(len(state.Documents))/1.5), 4.0) + // for _, s := range mng { + // b = append(b, []byte(fmt.Sprintf("%s,%f,%d,%d\n", s, state.NGrams[s].Weight(), state.NGrams[s].Count(), len(state.NGrams[s].Documents())))...) + // } + // if err := os.WriteFile("./meaningful-ngrams.csv", b, 0666); err != nil { + // panic(err) + // } // // TEST: remove later // - // TODO: other things? (file writes?) + // TODO: add threshold filtering params to these functions (use config) + kw := keywords.NGramsToKeywordsMap(s.state.NGrams) + notes := notes.DocumentsToNotes(s.state.Documents) - // serialize results for graph usage - if err := notes.SerializeDocuments(state.Documents); err != nil { - panic(err) - } - if err := keywords.SerializeNGrams(state.NGrams); err != nil { + dat, err := graph.SerializeGraph(kw, notes, 0.1, 80) + if err != nil { panic(err) } - kw := keywords.NGramsToKeywordsMap(state.NGrams) - n := notes.DocumentsToNotes(state.Documents) - - dat, err := graph.SerializeGraph(kw, n, 0.1, 80) - if err != nil { - return err - } + // TEST: remove json output later if err := os.WriteFile("graph.json", dat, 0644); err != nil { - return err + panic(err) } - return nil + log.Println("State update complete.") } From 8b7ab3c47b1367ed73378e7631ead2cb64e51824 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Sat, 23 Nov 2024 11:33:19 -0500 Subject: [PATCH 6/9] chore: added example note to pass tests --- examples/data/note.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 examples/data/note.md diff --git a/examples/data/note.md b/examples/data/note.md new file mode 100644 index 0000000..c9bd38e --- /dev/null +++ b/examples/data/note.md @@ -0,0 +1,23 @@ +# Oolong Development Notes +Oct 2, 2024 + +## Tokenizing -> NGram Flow + +- Frequency Score (tf-idf) + - requires number of occurrences in document + - number of occurrences across documents + - requires number of documents + - TF should be calculated at the document level + - IDF should be calculated after all documents are fully processed + +- Token/NGram info: + - Need to store all tokens in a document (and Ngrams) + - Store filepaths for each document + - Need occurences of ngrams in each document and in all documents + +## API + +- Build API for frontend-backend communication + - CRUD endpoints for files + - Weight recalculation trigger + - Graph data getter From ca59bfc824eb696d53415cceb7c72cb1e0200a04 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Sat, 23 Nov 2024 14:20:28 -0500 Subject: [PATCH 7/9] feat: api updates for create, update, delete notes --- internal/api/graph_handlers.go | 26 +++++++++--- internal/api/note_handlers.go | 76 ++++++++++++++++++++-------------- 2 files changed, 65 insertions(+), 37 deletions(-) diff --git a/internal/api/graph_handlers.go b/internal/api/graph_handlers.go index 6f5aa28..7151d3e 100644 --- a/internal/api/graph_handlers.go +++ b/internal/api/graph_handlers.go @@ -2,19 +2,35 @@ package api import ( "encoding/json" + "log" "net/http" + + "github.com/oolong-sh/oolong/internal/graph" + "github.com/oolong-sh/oolong/internal/keywords" + "github.com/oolong-sh/oolong/internal/notes" + "github.com/oolong-sh/oolong/internal/state" ) func handleGetGraph(w http.ResponseWriter, r *http.Request) { + log.Println("Request received:", r.Method, r.URL, r.Host) w.Header().Set("Content-Type", "application/json") - // TODO: server up graph json directly rather than writing to file + // get snapshot of current state + s := state.State() + + // convert state into serializable format for graph + kw := keywords.NGramsToKeywordsMap(s.NGrams) + notes := notes.DocumentsToNotes(s.Documents) - // TODO: finish implementation - // data, err := graph.SerializeGraph() - data := "" + // serialize graph data + // TODO: pass in thresholds (with request? or with config?) + data, err := graph.SerializeGraph(kw, notes, 0.1, 80) + if err != nil { + http.Error(w, "Error serializing graph data", 500) + } + // encode graph data in reponse if err := json.NewEncoder(w).Encode(data); err != nil { - http.Error(w, "Error encoding graph data", 400) + http.Error(w, "Error encoding graph data", 500) } } diff --git a/internal/api/note_handlers.go b/internal/api/note_handlers.go index 13dd30e..1bbdcb1 100644 --- a/internal/api/note_handlers.go +++ b/internal/api/note_handlers.go @@ -5,16 +5,22 @@ import ( "log" "net/http" "os" + "path/filepath" "github.com/oolong-sh/oolong/internal/state" ) +type createUpdateRequest struct { + Path string `json:"path"` + Content string `json:"content"` +} + // 'GET /notes' endpoint handler returns all available note paths func handleGetNotes(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) s := state.State() - data := make([]string, len(s.Documents)) + data := []string{} for k := range s.Documents { data = append(data, k) } @@ -23,8 +29,7 @@ func handleGetNotes(w http.ResponseWriter, r *http.Request) { json.NewEncoder(w).Encode(data) } -// 'GET /note/{path}' endpoint handler gets note contents corresponding to input path -// TODO: maybe change path to a request body/form item since it can have slashes +// 'GET /note?path=' endpoint handler gets note contents corresponding to input path func handleGetNote(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) @@ -50,46 +55,63 @@ func handleGetNote(w http.ResponseWriter, r *http.Request) { } } -// 'POST /note/{path}' endpoint handler creates note contents corresponding to input path +// 'POST /note' endpoint handler creates a note file (and any missing directories) corresponding to input path +// Expected request body: { "path": "/path/to/note", "content", "full note contents to write" } func handleCreateNote(w http.ResponseWriter, r *http.Request) { - log.Println("Request received:", r.Method, r.URL, r.Host) + log.Println("Request received:", r.Method, r.URL, r.Host, r.Body) - path := r.URL.Query().Get("path") - if path == "" { - http.Error(w, "Path parameter not specified ", http.StatusBadRequest) - return + // parse request body + var req createUpdateRequest + if err := json.NewDecoder(r.Body).Decode(&req); err != nil { + http.Error(w, "Failed to decode request body", 400) } // check if path before file exists, then check if file exists - if e, err := exists(path); err != nil { + if e, err := exists(req.Path); err != nil { log.Println(err) http.Error(w, "Error checking path", 500) return } else if e { - log.Printf("File %s already exists.\n", path) + log.Printf("File %s already exists.\n", req.Path) http.Error(w, "Note file already exists", 500) return } - // TODO: create directory case? - // - this will also require adding an additional watcher - _, err := os.Create(path) - if err != nil { + // create directories and file + dir := filepath.Dir(req.Path) + if err := os.MkdirAll(dir, os.ModePerm); err != nil { + log.Println(err) + http.Error(w, "Failed to create missing directories", 500) + return + } + if err := os.WriteFile(req.Path, []byte(req.Content), 0644); err != nil { log.Println(err) - http.Error(w, "Failed to create note file", 500) + http.Error(w, "Failed to create file directories", 500) return } } -// DOC: +// 'PUT /note' endpoint handler updates note contents corresponding to input path +// It will create files that do not exist, but will not create directories +// Expected request body: { "path": "/path/to/note", "content", "full note contents to write" } func handleUpdateNote(w http.ResponseWriter, r *http.Request) { - // TODO: allow writing notes + log.Println("Request received:", r.Method, r.URL, r.Host, r.Body) - // NOTE: DO NOT CALL STATE UPDATE HERE, LET WATCHER HANDLE IT - // - this function only needs to write to a file in the watched locations + // parse request body + var req createUpdateRequest + if err := json.NewDecoder(r.Body).Decode(&req); err != nil { + http.Error(w, "Failed to decode request body", 400) + } + + // write contents to file + if err := os.WriteFile(req.Path, []byte(req.Content), 0666); err != nil { + log.Println(err) + http.Error(w, "Failed to write to note file", 500) + return + } } -// DOC: +// 'Delete /note?path=/path/to/note' endpoint handler deletess a note file based on query input func handleDeleteNote(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) @@ -99,17 +121,7 @@ func handleDeleteNote(w http.ResponseWriter, r *http.Request) { return } - // check if path before file exists, then check if file exists - if e, err := exists(path); err != nil { - log.Println(err) - http.Error(w, "Error checking path", 500) - return - } else if !e { - log.Printf("File %s does not exists.\n", path) - http.Error(w, "File does not exist", 500) - return - } - + // attempt to remove file if err := os.Remove(path); err != nil { log.Println("Failed to delete file", err) http.Error(w, "Failed to remove file", 500) From c81c83ddd0def613a58a3942f2a234b8ee473085 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Sat, 23 Nov 2024 14:20:40 -0500 Subject: [PATCH 8/9] license: add license --- LICENSE | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 661 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. From 3c5e59145d3882ffe3d59e14e29965e50aab9f61 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Sun, 24 Nov 2024 13:16:34 -0500 Subject: [PATCH 9/9] fix/feat: improved graph and updated api to allow fetch from webpage --- graph-2d.html | 28 --------------- graph-3d.html | 35 ------------------ index.html | 54 ++++++++++++++++++++-------- internal/api/graph_handlers.go | 21 +++++++++-- internal/api/note_handlers.go | 6 ++-- internal/daemon/watcher.go | 27 +++++++++----- internal/graph/graph.go | 12 ++++--- internal/linking/ngrams/weighting.go | 13 ++++--- internal/notes/notes.go | 14 ++++++++ internal/state/state.go | 25 +++++++------ 10 files changed, 123 insertions(+), 112 deletions(-) delete mode 100644 graph-2d.html delete mode 100644 graph-3d.html diff --git a/graph-2d.html b/graph-2d.html deleted file mode 100644 index ccf1814..0000000 --- a/graph-2d.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - -
- - - diff --git a/graph-3d.html b/graph-3d.html deleted file mode 100644 index 661df53..0000000 --- a/graph-3d.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - -
- - - - diff --git a/index.html b/index.html index 661df53..f3b9879 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,6 @@ - @@ -16,20 +15,45 @@ diff --git a/internal/api/graph_handlers.go b/internal/api/graph_handlers.go index 7151d3e..bc156f2 100644 --- a/internal/api/graph_handlers.go +++ b/internal/api/graph_handlers.go @@ -1,9 +1,9 @@ package api import ( - "encoding/json" "log" "net/http" + "slices" "github.com/oolong-sh/oolong/internal/graph" "github.com/oolong-sh/oolong/internal/keywords" @@ -11,9 +11,22 @@ import ( "github.com/oolong-sh/oolong/internal/state" ) +var allowedOrigins = []string{ + "http://localhost:8000", +} + func handleGetGraph(w http.ResponseWriter, r *http.Request) { log.Println("Request received:", r.Method, r.URL, r.Host) w.Header().Set("Content-Type", "application/json") + origin := r.Header.Get("Origin") + + // check if the origin is whitelisted + if !slices.Contains(allowedOrigins, origin) { + log.Println("Requesting client not in allow list. Origin:", origin) + http.Error(w, "Request origin not in allow list", http.StatusForbidden) + return + } + w.Header().Set("Access-Control-Allow-Origin", origin) // get snapshot of current state s := state.State() @@ -30,7 +43,11 @@ func handleGetGraph(w http.ResponseWriter, r *http.Request) { } // encode graph data in reponse - if err := json.NewEncoder(w).Encode(data); err != nil { + if _, err := w.Write(data); err != nil { http.Error(w, "Error encoding graph data", 500) + return } + // if err := json.NewEncoder(w).Encode(data); err != nil { + // http.Error(w, "Error encoding graph data", 500) + // } } diff --git a/internal/api/note_handlers.go b/internal/api/note_handlers.go index 1bbdcb1..891b24e 100644 --- a/internal/api/note_handlers.go +++ b/internal/api/note_handlers.go @@ -58,13 +58,14 @@ func handleGetNote(w http.ResponseWriter, r *http.Request) { // 'POST /note' endpoint handler creates a note file (and any missing directories) corresponding to input path // Expected request body: { "path": "/path/to/note", "content", "full note contents to write" } func handleCreateNote(w http.ResponseWriter, r *http.Request) { - log.Println("Request received:", r.Method, r.URL, r.Host, r.Body) + log.Println("Request received:", r.Method, r.URL, r.Host) // parse request body var req createUpdateRequest if err := json.NewDecoder(r.Body).Decode(&req); err != nil { http.Error(w, "Failed to decode request body", 400) } + log.Println("Request body: ", req) // check if path before file exists, then check if file exists if e, err := exists(req.Path); err != nil { @@ -95,13 +96,14 @@ func handleCreateNote(w http.ResponseWriter, r *http.Request) { // It will create files that do not exist, but will not create directories // Expected request body: { "path": "/path/to/note", "content", "full note contents to write" } func handleUpdateNote(w http.ResponseWriter, r *http.Request) { - log.Println("Request received:", r.Method, r.URL, r.Host, r.Body) + log.Println("Request received:", r.Method, r.URL, r.Host) // parse request body var req createUpdateRequest if err := json.NewDecoder(r.Body).Decode(&req); err != nil { http.Error(w, "Failed to decode request body", 400) } + log.Println("Request body: ", req) // write contents to file if err := os.WriteFile(req.Path, []byte(req.Content), 0666); err != nil { diff --git a/internal/daemon/watcher.go b/internal/daemon/watcher.go index 5b22699..56888f1 100644 --- a/internal/daemon/watcher.go +++ b/internal/daemon/watcher.go @@ -4,6 +4,7 @@ import ( "errors" "io/fs" "log" + "os" "path/filepath" "slices" "time" @@ -50,7 +51,6 @@ func runNotesDirsWatcher(dirs ...string) error { } // watcher handler - // go func() { // running entire function as a goroutine, handler doesn't need to be one for { select { case event, ok := <-watcher.Events: @@ -58,11 +58,9 @@ func runNotesDirsWatcher(dirs ...string) error { log.Println("Watcher event channel returned bad result.") return errors.New("Invalid watcher errors channel value.") } - // log.Println("Event:", event) - // TODO: add new watcher in cases where new directories are created - - if event.Has(fsnotify.Write) { + switch { + case event.Has(fsnotify.Write): log.Println("Modified file:", event.Name) // write event is sent on write start, wait 500ms for write to finish @@ -72,6 +70,22 @@ func runNotesDirsWatcher(dirs ...string) error { documents.ReadDocuments(event.Name) // TODO: add dedup timer to prevent multi-write calls + + case event.Has(fsnotify.Remove): + log.Println("Removed file/directory", event.Name) + // TODO: remove from state + // - need to be careful with remove event as editors use it when writing files + // - state removal needs to also remove ngrams + // - should only trigger update on file deletions + + case event.Has(fsnotify.Create): + log.Println("Created file/directory", event.Name) + + if info, err := os.Stat(event.Name); err == nil { + if info.IsDir() { + watcher.Add(event.Name) + } + } } case err, ok := <-watcher.Errors: if !ok { @@ -80,7 +94,4 @@ func runNotesDirsWatcher(dirs ...string) error { log.Println("error:", err) } } - // }() - // <-make(chan struct{}) - // return nil } diff --git a/internal/graph/graph.go b/internal/graph/graph.go index 6ea2420..0596b69 100644 --- a/internal/graph/graph.go +++ b/internal/graph/graph.go @@ -15,8 +15,9 @@ type NodeJSON struct { } type LinkJSON struct { - Source string `json:"source"` - Target string `json:"target"` + Source string `json:"source"` + Target string `json:"target"` + Value float64 `json:"strength"` } type Graph struct { @@ -34,9 +35,10 @@ func clamp(value, min, max float64) float64 { return value } -const NOTE_NODE_VAL = 10 +const NOTE_NODE_VAL = 1 func SerializeGraph(keywordMap map[string]keywords.Keyword, notes []notes.Note, lowerBound, upperBound float64) ([]byte, error) { + // func SerializeGraph(keywordMap map[string]keywords.Keyword, notes []notes.Note, lowerBound, upperBound float64) (Graph, error) { nodes := []NodeJSON{} links := []LinkJSON{} @@ -63,12 +65,13 @@ func SerializeGraph(keywordMap map[string]keywords.Keyword, notes []notes.Note, }) // Link notes to keywords - for keywordID := range note.Weights { + for keywordID, wgt := range note.Weights { keyword, exists := keywordMap[keywordID] if exists && keyword.Weight >= lowerBound { links = append(links, LinkJSON{ Source: noteID, Target: keyword.Keyword, + Value: wgt, }) } } @@ -84,5 +87,6 @@ func SerializeGraph(keywordMap map[string]keywords.Keyword, notes []notes.Note, return nil, err } + // return graph, nil return jsonData, nil } diff --git a/internal/linking/ngrams/weighting.go b/internal/linking/ngrams/weighting.go index d2b66c2..38ee81c 100644 --- a/internal/linking/ngrams/weighting.go +++ b/internal/linking/ngrams/weighting.go @@ -46,12 +46,7 @@ var zoneB map[lexer.Zone]float64 = map[lexer.Zone]float64{ func CalcWeights(ngmap map[string]*NGram, N int) { idf(ngmap, N) // tfidf(ngmap) - // TODO: decide on k and b values (and allow them to be tweaked from config) bm25(ngmap) - // CHANGE: probably take n and word length into account - - // TODO: move adjustments to weights calculation function - // NOTE: these adjustments are much larger than the bm25 score and probably need to be scaled down for _, ng := range ngmap { ng.updateWeight() @@ -95,3 +90,11 @@ func FilterMeaningfulNGrams(ngmap map[string]*NGram, minDF int, maxDF int, minAv } return out } + +type Doc interface { + // get +} + +// TODO: +func NormalizeDocumentWeights() { +} diff --git a/internal/notes/notes.go b/internal/notes/notes.go index 24464f4..18fc5fa 100644 --- a/internal/notes/notes.go +++ b/internal/notes/notes.go @@ -2,6 +2,7 @@ package notes import ( "encoding/json" + "math" "github.com/oolong-sh/oolong/internal/documents" ) @@ -29,13 +30,20 @@ func DocumentsToNotes(documents map[string]*documents.Document) []Note { threshold := 2.0 for k, v := range documents { + weightSum := 0.0 weights := map[string]float64{} + + // set weight values for k, v := range v.Weights { if v > threshold { weights[k] = v + weightSum += v * v } } + // normalize resulting weights + normalizeWeights(weights, math.Sqrt(weightSum)) + notes = append(notes, Note{ Path: k, Weights: weights, @@ -44,3 +52,9 @@ func DocumentsToNotes(documents map[string]*documents.Document) []Note { return notes } + +func normalizeWeights(m map[string]float64, sum float64) { + for k, v := range m { + m[k] = v / sum + } +} diff --git a/internal/state/state.go b/internal/state/state.go index 86be0a9..3c7ced4 100644 --- a/internal/state/state.go +++ b/internal/state/state.go @@ -3,13 +3,9 @@ package state import ( "fmt" "log" - "os" "github.com/oolong-sh/oolong/internal/documents" - "github.com/oolong-sh/oolong/internal/graph" - "github.com/oolong-sh/oolong/internal/keywords" "github.com/oolong-sh/oolong/internal/linking/ngrams" - "github.com/oolong-sh/oolong/internal/notes" ) type OolongState struct { @@ -113,18 +109,21 @@ func (s *StateManager) updateState(docs []*documents.Document) { // // TODO: add threshold filtering params to these functions (use config) - kw := keywords.NGramsToKeywordsMap(s.state.NGrams) - notes := notes.DocumentsToNotes(s.state.Documents) + // kw := keywords.NGramsToKeywordsMap(s.state.NGrams) + // notes := notes.DocumentsToNotes(s.state.Documents) - dat, err := graph.SerializeGraph(kw, notes, 0.1, 80) - if err != nil { - panic(err) - } + // REFACTOR: store graph json in state field to make it available on request earlier? + // - this is probably a good idea + // + // dat, err := graph.SerializeGraph(kw, notes, 0.1, 80) + // if err != nil { + // panic(err) + // } // TEST: remove json output later - if err := os.WriteFile("graph.json", dat, 0644); err != nil { - panic(err) - } + // if err := os.WriteFile("graph.json", dat, 0644); err != nil { + // panic(err) + // } log.Println("State update complete.") }