webmention

README

go.mills.io/webmention

go.mills.io/webmention is a Go library that implements support for the IndieWeb WebMention protocol. Both client and server support are included.

Quick Start

TBD

License

go.mills.io/webmention is licensed under the terms of the MIT license

Documentation

Overview

Package webmention implements the IndieWeb WebMention protocol

Index

• type Callback
• type Link
  • func GetHeaderLinks(headers []string) []*Link
• type WebMention
  • func New() WebMention

Types

type Callback

type Callback func(source, target *url.URL, sourceData *microformats.Data)

Callback is a function that is called on receipt of a processed incoming webmention Use this to perform function calls of inboudn webmentions. The source and target URL(s) as well as any discovered and parsed microformats data found on the source page are passed to the function.

type Link

type Link struct {
	URL    *url.URL
	Params map[string][]string
}

Link is a URL with one or more optional parameters for example: link: <https://twtxt.net/webmention>; rel="webmention"

func GetHeaderLinks

func GetHeaderLinks(headers []string) []*Link

GetHeaderLinks parses a slice of `Link:` HTTP headers (without the "Link:" prefix) into a slice of `Link`(s) used for discovering the webmention endpoints of a target URL.

type WebMention

type WebMention interface {
	http.Handler
	Notify(target *url.URL, source *url.URL)
	SetCallback(fn Callback)
}

WebMention defines an interface for handling inbound and outbound webmentions which must implement the `http.Handler` interface and a few methods for sending outbound notifications to a webmention target and setting a callback function for received inbound webmentions from a source.

func New

func New() WebMention

New creates a new default WebMention processor for handling inbound and outbound webmentions