pageview

README

PageView

• PageView
  • Purpose
  • Installation
  • Usage
  • Libraries
  • Credits
  • Licence

---

Purpose

Sometimes yoo don't want just standard web links in your web pages but a preview image showing the page you`re linking to. That is where this small package comes in. It generates – by way of calling the external wkhtmltopdf commandline utility – an image of the web page a given URL addresses. Those image files are stored locally and may be used as often as you want.

Installation

You can use Go to install this package for you:

go get github.com/mwat56/pageview

After that you can import it the usual Go way to use the library.

Usage

There are only two functions you have to worry about:

// SetCacheDirectory sets the directory to use for storing the
// generated images returning an error if `aDirectory` can't be used.
//
//	`aDirectory` The directory to store the generated images.
func SetCacheDirectory(aDirectory string) error { … }

This function must be called before any other one to make sure the generated images end up where you want them to be.

To actually create an image you'd call:

// CreateImage generates an image of `aURL` and stores it in
// `CacheDirectory` returning the file name of the saved image.
//
//	`aURL` The address of the web page to process.
func CreateImage(aURL string) (string, error) { … }

The returned string is the name of the generated image file. If you combine it with the directory returned by CacheDirectory() you get the complete path/filename to locally access the image.

There are a few more functions which you will barely need; for details refer to the source code documentation

Libraries

The great commandline utility

• wkhtmltopdf

is required for this package to work.

Under Linux this utility is usually part of your distribution. If not, you can download wkhtmltopdf from the web and install it.

Credits

Part of the code (i.e. the file wkhtmltoimage.go) started as a modified version of go-wkhtmltoimage, Copyright (c) 2015 ninetwentyfour

Licence

    Copyright © 2019 M.Watermann, 10247 Berlin, Germany
                    All rights reserved
                EMail : <support@mwat.de>

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 software 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.

You should have received a copy of the GNU General Public License along with this program. If not, see the GNU General Public License for details.

---

Documentation

Overview

Package pageview implements a web page link preview.

Copyright © 2019 M.Watermann, 10247 Berlin, Germany
                All rights reserved
            EMail : <support@mwat.de>

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 software 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.

You should have received a copy of the GNU General Public License along with this program. If not, see the [GNU General Public License](http://www.gnu.org/licenses/gpl.html) for details.

Index

• func CreateImage(aURL string) (string, error)
• func ImageDirectory() string
• func ImageFileType() string
• func ImageHeight() int
• func ImageQuality() int
• func ImageWidth() int
• func MaxAge() time.Duration
• func PathFile(aURL string) string
• func SetImageDirectory(aDirectory string) error
• func SetImageFileType(aType string)
• func SetImageHeight(aHeight int)
• func SetImageQuality(aQuality int)
• func SetImageWidth(aWidth int)
• func SetMaxAge(aLengthInSeconds time.Duration)

Functions

func CreateImage

func CreateImage(aURL string) (string, error)

CreateImage generates an image of `aURL` and stores it in `ImageDirectory()`, returning the file name of the saved image.

`aURL` The address of the web page to process.

func ImageDirectory

func ImageDirectory() string

ImageDirectory returns the directory used to store the generated images.

func ImageFileType

func ImageFileType() string

ImageFileType returns the type of the image fles to generate.

func ImageHeight

func ImageHeight() int

ImageHeight is the height in pixels of the imaginary screen used to render. The default value is `768`.

The value `0` (zero) renders the entire page top to bottom, calculating the actual height from the page content.

func ImageQuality

func ImageQuality() int

ImageQuality returns the desired image quality.

func ImageWidth

func ImageWidth() int

ImageWidth is the width in pixels of the imaginary screen used to render. The default value is `1024`. Note that this is used only as a guide line.

func MaxAge

func MaxAge() time.Duration

MaxAge returns the maximimum age of cached page images.

func PathFile

func PathFile(aURL string) string

PathFile returns the complete local path/file of `aURL`.

NOTE: This function does not check whether the file for `aURL` actually exists in the local filesystem.

`aURL` The address of the web page to process.

func SetImageDirectory

func SetImageDirectory(aDirectory string) error

SetImageDirectory sets the directory to use for storing the generated images, returning an error if `aDirectory` can't be used.

`aDirectory` The directory to store the generated images.

func SetImageFileType

func SetImageFileType(aType string)

SetImageFileType changes the type of the generated images. The default type is `png`, the other options are `gif`, `jpg` and `svg`. Passing an invalid value in `aType` will result in `png` being selected.

NOTE: Depending on how your `wkhtmltoimage` binary was compiled not all formats might be supported.

`aType` is the new desired type of the images to generate.

func SetImageHeight

func SetImageHeight(aHeight int)

SetImageHeight sets the height of the images to generate. The default value is `768`.

`aHeight` The new height of the images to generate.

func SetImageQuality

func SetImageQuality(aQuality int)

SetImageQuality changes the quality of the genereated image. Values supported between `1` and `100`; default is `100`.

`aQuality` the new desired image quality.

func SetImageWidth

func SetImageWidth(aWidth int)

SetImageWidth sets the width of the images to generate. The default value is `1024`.

`aWidth` The new width of the images to generate.

func SetMaxAge

func SetMaxAge(aLengthInSeconds time.Duration)

SetMaxAge sets the maximum age of cached page images before they might get updated.

Usually you want this property at its default value (`0`, zero) which disables an age check because you want an image of the page at the time you linked to it.

`aLengthInSeconds` is the age a page image can have before

requesting it again.