13 Commits

16 changed files with 213 additions and 20 deletions

1
.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
content/corpora/* linguist-vendored

72
.github/workflows/codeql-analysis.yml vendored Normal file
View File

@@ -0,0 +1,72 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: [ main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
schedule:
- cron: '18 22 * * 2'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'go', 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name: Checkout repository
uses: actions/checkout@v3
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
# Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2

25
.github/workflows/go.yml vendored Normal file
View File

@@ -0,0 +1,25 @@
name: Go
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: 1.18
- name: Build
run: go build -v ./...
- name: Test
run: go test -v ./...

View File

@@ -21,7 +21,7 @@ dockers:
build_flag_templates: build_flag_templates:
- "--platform=linux/amd64" - "--platform=linux/amd64"
nfpms: nfpms:
- -
id: default id: default
package_name: linkwallet package_name: linkwallet
file_name_template: "{{ .ConventionalFileName }}" file_name_template: "{{ .ConventionalFileName }}"
@@ -86,6 +86,7 @@ changelog:
sort: asc sort: asc
filters: filters:
exclude: exclude:
- '^Merge:'
- '^docs:' - '^docs:'
- '^test:' - '^test:'
- '^[Bb]ump' - '^[Bb]ump'

View File

@@ -32,6 +32,14 @@ A self-hosted bookmark database with full-text page content search.
mountpoint. mountpoint.
* Run `docker-compose up -d` * Run `docker-compose up -d`
## Packages (deb/rpm)
* Download the .deb or .rpm from the releases
* Install using apt/dpkg/rpm
* Automatically creates a systemd service, enabled and started
* Runs as user `linkwallet`
* Database stored in `/var/lib/linkwallet`
## Binary ## Binary
* Download the appropriate binary from the releases page * Download the appropriate binary from the releases page
@@ -44,10 +52,6 @@ A self-hosted bookmark database with full-text page content search.
* Checkout the code * Checkout the code
* `go build cmd/linkwallet/linkwallet.go` * `go build cmd/linkwallet/linkwallet.go`
## deb/rpm packages
Coming soon.
# Using # Using
linkwallet is a 100% web-driven app. After running, hit the web interface linkwallet is a 100% web-driven app. After running, hit the web interface
@@ -66,5 +70,4 @@ will not work.
* delete * delete
* sorting * sorting
* More tag options * More tag options
* search for tags
* bookmarklet with pre-filled tags * bookmarklet with pre-filled tags

View File

@@ -131,8 +131,6 @@ func (m *BookmarkManager) Search(query string) ([]entity.Bookmark, error) {
} }
} }
// log.Printf("counts: %#v", counts)
for k, v := range counts { for k, v := range counts {
if v == uint8(len(words)) { if v == uint8(len(words)) {
rets = append(rets, k) rets = append(rets, k)
@@ -149,6 +147,10 @@ func (m *BookmarkManager) ScrapeAndIndex(bm *entity.Bookmark) error {
log.Printf("Start scrape for %s", bm.URL) log.Printf("Start scrape for %s", bm.URL)
info := content.FetchPageInfo(*bm) info := content.FetchPageInfo(*bm)
// keep the existing title if necessary
if bm.PreserveTitle {
info.Title = bm.Info.Title
}
bm.Info = info bm.Info = info
bm.TimestampLastScraped = time.Now() bm.TimestampLastScraped = time.Now()
err := m.SaveBookmark(bm) err := m.SaveBookmark(bm)
@@ -156,11 +158,16 @@ func (m *BookmarkManager) ScrapeAndIndex(bm *entity.Bookmark) error {
panic(err) panic(err)
} }
m.UpdateIndexForBookmark(bm)
return nil
}
func (m *BookmarkManager) UpdateIndexForBookmark(bm *entity.Bookmark) {
words := content.Words(bm) words := content.Words(bm)
words = append(words, bm.Tags...)
log.Printf("index for %d %s (%d words)", bm.ID, bm.URL, len(words)) log.Printf("index for %d %s (%d words)", bm.ID, bm.URL, len(words))
m.db.UpdateIndexForWordsByID(words, bm.ID) m.db.UpdateIndexForWordsByID(words, bm.ID)
return nil
} }
func (m *BookmarkManager) QueueScrape(bm *entity.Bookmark) { func (m *BookmarkManager) QueueScrape(bm *entity.Bookmark) {

View File

@@ -92,3 +92,52 @@ func TestAddRemove(t *testing.T) {
} }
} }
func TestTagIndexing(t *testing.T) {
ts := newTestServer()
defer ts.Close()
serverResponse = "<p>the quick brown fox</p>"
db := DB{}
f, _ := os.CreateTemp("", "test_boltdb_*")
f.Close()
defer os.Remove(f.Name())
db.Open(f.Name())
bmm := NewBookmarkManager(&db)
bm := entity.Bookmark{URL: ts.URL}
err := bmm.AddBookmark(&bm)
if err != nil {
t.Fatalf("error adding: %s", err)
}
if bm.ID == 0 {
t.Error("bookmark did not get an id")
}
err = bmm.ScrapeAndIndex(&bm)
if err != nil {
t.Errorf("scrape index returned %s", err)
}
searchRes, err := bmm.Search("fox")
if err != nil {
t.Errorf("search returned %s", err)
}
if len(searchRes) != 1 {
t.Error("did not get one id")
}
// add a tag
bm.Tags = []string{"sloth"}
err = bmm.ScrapeAndIndex(&bm)
if err != nil {
t.Errorf("scrape index returned %s", err)
}
searchRes, err = bmm.Search("sloth")
if err != nil {
t.Errorf("search returned %s", err)
}
if len(searchRes) != 1 {
t.Error("did not get one id for sloth")
}
}

View File

@@ -7,6 +7,7 @@ type Bookmark struct {
URL string URL string
Info PageInfo Info PageInfo
Tags []string Tags []string
PreserveTitle bool
TimestampCreated time.Time TimestampCreated time.Time
TimestampLastScraped time.Time TimestampLastScraped time.Time
} }

View File

@@ -8,7 +8,7 @@ import (
"golang.org/x/mod/semver" "golang.org/x/mod/semver"
) )
const Tag = "v0.0.15" const Tag = "v0.0.18"
var versionInfo struct { var versionInfo struct {
Local struct { Local struct {
@@ -40,7 +40,14 @@ func UpgradeAvailable() (bool, string) {
return true, versionInfo.Remote.Tag return true, versionInfo.Remote.Tag
} }
return false, "" return false, ""
}
func UpgradeAvailableString() string {
upgrade, ver := UpgradeAvailable()
if upgrade {
return ver
}
return ""
} }
func UpdateVersionInfo() { func UpdateVersionInfo() {

File diff suppressed because one or more lines are too long

View File

@@ -6,9 +6,11 @@
<meta http-equiv="x-ua-compatible" content="ie=edge"> <meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>linkwallet</title> <title>linkwallet</title>
<link rel="stylesheet" href="/assets/css/foundation.css"> <link rel="stylesheet" href="/assets/css/foundation.min.css">
<link rel="stylesheet" href="/assets/css/app.css"> <link rel="stylesheet" href="/assets/css/app.css">
<script src="/assets/js/htmx.min.js" defer></script> <script src="/assets/js/vendor/htmx.min.js" defer></script>
<script src="/assets/js/vendor/hyperscript_web.min.js"></script>
</head> </head>
<body> <body>
@@ -32,10 +34,17 @@
</div> </div>
<div class="top-bar-right"> <div class="top-bar-right">
<ul class="menu"> <ul class="menu">
{{ if newVersion }}
<li>
<div><a href="https://github.com/tardisx/linkwallet/releases/tag/{{ newVersion }}">{{ newVersion }} available</a></div>
</li>
{{ end }}
<li class="menu-text">
{{ version }}
</li>
<li> <li>
<a href="https://github.com/tardisx/linkwallet"> <a href="https://github.com/tardisx/linkwallet">
{{ version }} <img src="/assets/image/GitHub-Mark-32px.png" width="16px" height="16px"/>
<img src="/assets/image/GitHub-Mark-32px.png" />
</a> </a>
</li> </li>
<!-- <li><input type="search" placeholder="Search"></li> <!-- <li><input type="search" placeholder="Search"></li>

View File

@@ -7,7 +7,7 @@
<form onsubmit="return false"> <form onsubmit="return false">
<div class="grid-x grid-padding-x"> <div class="grid-x grid-padding-x">
<div class="large-6 cell"> <div class="large-6 cell">
<label>Paste a URL</label> <label>URL</label>
<input type="text" name="url" value="{{ .url }}" <input type="text" name="url" value="{{ .url }}"
hx-trigger="" hx-trigger=""
/> />

View File

@@ -9,7 +9,7 @@
<p>Then whenever you are on a webpage you would like to bookmark, just <p>Then whenever you are on a webpage you would like to bookmark, just
click the bookmarklet.</p> click the bookmarklet.</p>
<a class="button" href="javascript:void(window.open('{{ .config.BaseURL }}/bookmarklet?url=' +encodeURIComponent(window.location), 'windowName', 'width=640,height=480'))">Bookmarklet</a> <a class="button" href="javascript:void(window.open('{{ .config.BaseURL }}/bookmarklet?url=' +encodeURIComponent(window.location)+'&title='+encodeURIComponent(document.title), 'windowName', 'width=640,height=480'))">Bookmarklet</a>
{{ else }} {{ else }}

View File

@@ -3,7 +3,11 @@
<table> <table>
<tr> <tr>
<th>Title</th> <th>Title</th>
<td>{{ .bookmark.Info.Title }}</td> <td>
<input type="text" name="title" {{ if not .bookmark.PreserveTitle }}disabled{{ end }} id="title" value="{{ .bookmark.Info.Title }}">
<input id="checkbox" name="override_title" value="on" {{ if .bookmark.PreserveTitle }}checked{{end}} type="checkbox" _="on click toggle @disabled on #title">
<label for="checkbox">override scraped title (ignore page title when scraping)</label>
</td>
</tr> </tr>
<tr> <tr>
<th>URL</th> <th>URL</th>

View File

@@ -51,7 +51,7 @@ func Create(bmm *db.BookmarkManager, cmm *db.ConfigManager) *Server {
} }
// templ := template.Must(template.New("").Funcs(template.FuncMap{"dict": dictHelper}).ParseFS(templateFiles, "templates/*.html")) // templ := template.Must(template.New("").Funcs(template.FuncMap{"dict": dictHelper}).ParseFS(templateFiles, "templates/*.html"))
templ := template.Must(template.New("").Funcs(template.FuncMap{"nicetime": niceTime, "niceURL": niceURL, "join": strings.Join, "version": version.Is}).ParseFS(templateFiles, "templates/*.html")) templ := template.Must(template.New("").Funcs(template.FuncMap{"nicetime": niceTime, "niceURL": niceURL, "join": strings.Join, "version": version.Is, "newVersion": version.UpgradeAvailableString}).ParseFS(templateFiles, "templates/*.html"))
config, err := cmm.LoadConfig() config, err := cmm.LoadConfig()
if err != nil { if err != nil {
@@ -95,6 +95,7 @@ func Create(bmm *db.BookmarkManager, cmm *db.ConfigManager) *Server {
r.POST("/config", func(c *gin.Context) { r.POST("/config", func(c *gin.Context) {
config.BaseURL = c.PostForm("baseurl") config.BaseURL = c.PostForm("baseurl")
config.BaseURL = strings.TrimRight(config.BaseURL, "/")
cmm.SaveConfig(&config) cmm.SaveConfig(&config)
meta := gin.H{"config": config} meta := gin.H{"config": config}
@@ -160,7 +161,6 @@ func Create(bmm *db.BookmarkManager, cmm *db.ConfigManager) *Server {
} }
} }
log.Printf("well done %v, %d", totalErrors, added)
data := gin.H{ data := gin.H{
"added": added, "added": added,
"errors": totalErrors, "errors": totalErrors,
@@ -261,6 +261,16 @@ func Create(bmm *db.BookmarkManager, cmm *db.ConfigManager) *Server {
bookmark := bmm.LoadBookmarkByID(bookmarkID) bookmark := bmm.LoadBookmarkByID(bookmarkID)
// update title and override title
overrideTitle := c.PostForm("override_title")
if overrideTitle != "" {
title := c.PostForm("title")
bookmark.Info.Title = title
bookmark.PreserveTitle = true
} else {
bookmark.PreserveTitle = false
}
// freshen tags // freshen tags
if c.PostForm("tags_hidden") == "" { if c.PostForm("tags_hidden") == "" {
// empty // empty
@@ -268,7 +278,9 @@ func Create(bmm *db.BookmarkManager, cmm *db.ConfigManager) *Server {
} else { } else {
bookmark.Tags = strings.Split(c.PostForm("tags_hidden"), "|") bookmark.Tags = strings.Split(c.PostForm("tags_hidden"), "|")
} }
bmm.SaveBookmark(&bookmark) bmm.SaveBookmark(&bookmark)
bmm.UpdateIndexForBookmark(&bookmark) // because title may have changed
meta := gin.H{"page": "edit", "bookmark": bookmark, "tw": gin.H{"tags": bookmark.Tags, "tags_hidden": strings.Join(bookmark.Tags, "|")}} meta := gin.H{"page": "edit", "bookmark": bookmark, "tw": gin.H{"tags": bookmark.Tags, "tags_hidden": strings.Join(bookmark.Tags, "|")}}