ShaarliGo/api0_test.go

//
// Copyright (C) 2017-2021 Marcus Rohrmoser, http://purl.mro.name/ShaarliGo
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

package main

import (
	"crypto/rand"
	"encoding/base64"
	"encoding/binary"
	"encoding/hex"
	"fmt"
	"hash/crc32"
	"io"
	"net/url"
	"strings"
	"time"

	"github.com/stretchr/testify/assert"
	"testing"
)

func TestURLQuery(t *testing.T) {
	t.Parallel()

	par := mustParseURL("a/b/c?post=foo").Query()
	assert.Equal(t, 1, len(par["post"]), "Na klar")
	assert.Equal(t, "foo", par["post"][0], "Na klar")

	nul := mustParseURL("")
	assert.False(t, nul.IsAbs(), "Na klar")

	http := mustParseURL("http://")
	assert.True(t, http.IsAbs(), "Na klar")
	assert.Equal(t, "", http.Hostname(), "Na klar")

	purl := fmt.Sprintf("?post=%s&title=%s&source=%s", url.QueryEscape("http://example.com/foo?bar=baz#grr"), url.QueryEscape("A first post"), url.QueryEscape("me"))
	par = mustParseURL(purl).Query()
	assert.Equal(t, 1, len(par["post"]), "Na klar")
	assert.Equal(t, "http://example.com/foo?bar=baz#grr", par["post"][0], "Na klar")
	assert.Equal(t, "A first post", par["title"][0], "Na klar")
	assert.Equal(t, "me", par["source"][0], "Na klar")

	assert.Equal(t, "foo", strings.SplitN("pub/posts/foo/", "/", 4)[2], "Na klar")
}

func TestLfTimeFmt(t *testing.T) {
	t.Parallel()

	loc, err := time.LoadLocation("Europe/Berlin")
	assert.Nil(t, err, "aua")
	// loc = time.Local

	t0, err := time.ParseInLocation(fmtTimeLfTime, "20171106_223225", loc)
	assert.Nil(t, err, "aua")
	assert.Equal(t, "2017-11-06T22:32:25+01:00", t0.Format(time.RFC3339), "Na klar")
	assert.Equal(t, "20171106_223225", t0.Format(fmtTimeLfTime), "Na klar")
}

func TestParseLinkUrl(t *testing.T) {
	t.Parallel()

	// vorher schon geklärt:
	// - ist's die rechte Seite von :// eines bekannten Links
	// - ist's eine Id eines bekannten Links

	u, e := url.Parse("www.heise.de")
	assert.Nil(t, e, "aua")
	assert.Equal(t, "www.heise.de", u.String(), "aua")
	assert.False(t, u.IsAbs(), "aua")

	u, e = url.Parse("http://www.heise.de")
	assert.Equal(t, "http://www.heise.de", u.String(), "aua")
	assert.True(t, u.IsAbs(), "aua")

	u, e = url.Parse("https://www.heise.de")
	assert.Equal(t, "https://www.heise.de", u.String(), "aua")
	assert.True(t, u.IsAbs(), "aua")

	u, e = url.Parse("voo8Uo")
	assert.Equal(t, "voo8Uo", u.String(), "aua")
	assert.False(t, u.IsAbs(), "aua")

	assert.Nil(t, e, "aua")
	assert.NotNil(t, u, "aua")

	assert.Equal(t, "http://heise.de", parseLinkUrl("heise.de").String(), "aua")
	assert.Equal(t, "http://heise.de", parseLinkUrl("http://heise.de").String(), "aua")
	assert.Equal(t, "https://heise.de", parseLinkUrl("https://heise.de").String(), "aua")
	assert.Nil(t, parseLinkUrl("Eine Notiz"), "aua")
	assert.Nil(t, parseLinkUrl("genau www.heise.de"), "aua")
}

func TestToken(t *testing.T) {
	t.Parallel()

	src := []byte("foo\x00bar8901234567890")
	assert.Equal(t, 20, len(src), "sicher")
	hx := hex.EncodeToString(src)
	assert.Equal(t, 40, len(hx), "sicher")
	assert.Equal(t, "666f6f0062617238393031323334353637383930", hx, "Na klar")

	src = make([]byte, 20)
	_, err := io.ReadFull(rand.Reader, src)
	assert.Nil(t, err, "aua")
	assert.NotNil(t, hex.EncodeToString(src), "aua")
}

/*
Returns the small hash of a string, using RFC 4648 base64url format

	eg. smallHash('20111006_131924') --> yZH23w
	Small hashes:
	  - are unique (well, as unique as crc32, at last)
	  - are always 6 characters long.
	  - only use the following characters: a-z A-Z 0-9 - _ @
	  - are NOT cryptographically secure (they CAN be forged)
	In Shaarli, they are used as a tinyurl-like link to individual entries.

	https://github.com/sebsauvage/Shaarli/blob/master/index.php#L228
*/
func smallHash(text string) string {
	// ret:= rtrim(base64_encode(hash('crc32',$text,true)),'=');
	crc := crc32.ChecksumIEEE([]byte(text))
	bs := make([]byte, 4) // https://stackoverflow.com/a/16889357
	binary.LittleEndian.PutUint32(bs, crc)
	return base64.RawURLEncoding.EncodeToString(bs)
}

func smallDateHash(tt time.Time) string {
	bs := make([]byte, 4) // https://stackoverflow.com/a/16889357
	// unix time in seconds as uint32
	binary.LittleEndian.PutUint32(bs, uint32(tt.Unix()&0xFFFFFFFF))
	return base64.RawURLEncoding.EncodeToString(bs)
}

/*
func smallHashRandom() string {
	bs := make([]byte, 4)
	io.ReadFull(rand.Reader, bs)
	return base64.RawURLEncoding.EncodeToString(bs)
}
*/

func TestSmallHash(t *testing.T) {
	t.Parallel()

	// assert.Equal(t, uint32(0xc2d07353), crc32.Checksum([]byte("20171108_231054"), crc32.MakeTable((0xC96C5795<<32)|0xD7870F42)), "hm")
	// assert.Equal(t, "wtBzUw", smallHash("20171108_231054"), "aha")
	// assert.Equal(t, "yZH23w", smallHash("20111006_131924"), "the original from https://github.com/sebsauvage/Shaarli/blob/master/index.php#L228")
	assert.Equal(t, "AfsQ8g", smallHash("20111006_131924"), "strange - that's what GO produces.")

	tt, _ := time.Parse(fmtTimeLfTime, "20171108_231054")
	assert.Equal(t, "_o4DWg", smallDateHash(tt), "aha")
}

func TestApi0LinkFormMap(t *testing.T) {
	t.Parallel()

	e := Entry{}
	assert.Equal(t, map[string]interface{}{"lf_description": "", "lf_linkdate": "00010101_000000", "lf_tags": "", "lf_title": ""}, e.api0LinkFormMap(), "oha")

	e = Entry{
		Title: HumanText{Body: "My #Post"},
	}
	assert.Equal(t, map[string]interface{}{"lf_description": "", "lf_linkdate": "00010101_000000", "lf_tags": "Post", "lf_title": "My #Post"}, e.api0LinkFormMap(), "oha")

	e = Entry{
		Title:      HumanText{Body: "My #Post"},
		Categories: []Category{{Term: "Post"}, {Term: "tag1"}},
	}
	assert.Equal(t, map[string]interface{}{"lf_description": "#tag1", "lf_linkdate": "00010101_000000", "lf_tags": "Post tag1", "lf_title": "My #Post"}, e.api0LinkFormMap(), "oha")
	// assert.Equal(t, map[string]string{"lf_linkdate": "00010101_000000", "lf_title": "My #Post", "lf_tags": "tag1"}, e.api0LinkFormMap(), "oha")
}

func TestUrlFromPostParam(t *testing.T) {
	t.Parallel()

	assert.Equal(t, "http://foo", urlFromPostParam("http://foo").String(), "oha")
	assert.Equal(t, "http://foo.de", urlFromPostParam("foo.de").String(), "oha")
	assert.Equal(t, "http://example.com/und?noch#was", urlFromPostParam("example.com/und?noch#was").String(), "oha")
	assert.Nil(t, urlFromPostParam("/sub/dir#frag"), "oha")
	assert.Nil(t, urlFromPostParam("two parts"), "oha")
	assert.Nil(t, urlFromPostParam("#two"), "oha")
	assert.Nil(t, urlFromPostParam("example.com und noch was"), "oha")
	assert.Nil(t, urlFromPostParam("http://example.com und noch was"), "oha")
	assert.Nil(t, urlFromPostParam("foohoo"), "oha")
}

func TestSanitiseURLString(t *testing.T) {
	// sanitizeUrl
	t.Parallel()

	sanitizers := []RegexpReplaceAllString{
		{Regexp: "[\\?&]utm_source=.*$", ReplaceAllString: ""}, // We remove the annoying parameters added by FeedBurner and GoogleFeedProxy (?utm_source=...)
		{Regexp: "#xtor=RSS-.*$", ReplaceAllString: ""},
		{Regexp: "^(?i)(?:https?://)?(?:(?:www|m)\\.)?heise\\.de/.*?(-\\d+)(?:\\.html)?(?:[\\?#].*)?$", ReplaceAllString: "https://heise.de/${1}"},
		{Regexp: "^(?i)(?:https?://)?(?:(?:www|m)\\.)?spiegel\\.de/.*?-(\\d+)(?:\\.html.*)?", ReplaceAllString: "https://spiegel.de/article.do?id=${1}"},
		{Regexp: "^(?i)(?:https?://)?(?:(?:www|m)\\.)?sueddeutsche\\.de/.*?-(\\d+\\.\\d+)(?:\\.html.*)?$", ReplaceAllString: "https://sz.de/${1}"},
		{Regexp: "^(?i)(?:https?://)?(?:(?:www|m)\\.)?youtube.com/watch\\?v=([^&]+)(?:.*&(t=[^&]+))?(?:.*)$", ReplaceAllString: "https://youtu.be/${1}?${2}"},
	}

	assert.Equal(t, "https://heise.de/-3905244", sanitiseURLString("www.heise.de/newsticker/meldung/Finanzaufsicht-warnt-vor-Bitcoin-Investment-Kurs-sackt-wieder-unter-10-000-US-Dollar-3905244.html", sanitizers), "oha")
	assert.Equal(t, "https://spiegel.de/article.do?id=1181168", sanitiseURLString("https://www.spiegel.de/politik/ausland/glyphosat-barbara-hendricks-und-christian-schmidt-sprechen-sich-aus-a-1181168.html", sanitizers), "oha")
	assert.Equal(t, "https://sz.de/1.3772485", sanitiseURLString("http://www.sueddeutsche.de/politik/exklusiv-spd-ministerpraesident-weil-warnt-vor-instabilitaet-in-deutschland-1.3772485", sanitizers), "oha")
	assert.Equal(t, "https://youtu.be/hzf3hTUKk8U?", sanitiseURLString("https://www.youtube.com/watch?v=hzf3hTUKk8U&feature=youtu.be", sanitizers), "oha")
	assert.Equal(t, "https://youtu.be/hzf3hTUKk8U?t=14m4s", sanitiseURLString("youtube.com/watch?v=hzf3hTUKk8U&feature=youtu.be&t=14m4s", sanitizers), "oha")
	assert.Equal(t, "https://youtu.be/e-5obm1G_FY?t=14m4s", sanitiseURLString("https://youtu.be/e-5obm1G_FY?t=14m4s", sanitizers), "oha")
}