coderdojo/delorean

PHP Console app that downloads screenshots from the Internet Archive Wayback Machine

Maintainers

Details

github.com/CoderDojoScotland/delorean

Source

Issues

Installs: 29

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 9

Forks: 0

Open Issues: 0

1.0 2015-10-22 09:19 UTC

Requires

MIT 7db28c9da2b93deccf7c19c4c11d7048803d594d

  • David Rushton <david.woop@papertank.co.uk>

This package is not auto-updated.

Last update: 2024-05-15 15:39:44 UTC

README

This PHP command line (console) app allows you to generate screenshots of websites from the past and present, courtesy of Wayback Machine by The Internet Archive.

Installation

Install this application through Composer.

If you don't have Composer installed yet, run

curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

Once you have Composer, you can install the app an it's depencies with

composer create-project coderdojo/delorean

Alternatively, if you prefer to clone this Git repository, you can install the dependencies only with the following (inside the app root).

composer install

Requirements

This package is designed to work with PHP >= 5.6 over the command line.

Usage

Generate Screenshots

You can generate a past and present screenshot of a specific website by using the command: php delorean screenshot <url> [--years=10]

In other words,

php delorean screenshot http://google.com

will generate a screenshot for the present day, plus one from the past using the default number of years (which is 10).

To change the number of years ago for the past screenshot, you can pass this as an option.

php delorean screenshot http://google.com --years=5

How it Works

The delorean file in the project root is a command line php script that registers a new Symfony console application, currently with one command.

The src/ScreenshotCommand.php file contains the code that is run when you put php delorean screenshot http://google.com in the command line. Have a look in this file to check the process of getting the URL and number of years. The getSnapshotUrl() method in this file connects to the Wayback Machine API to find the right URL for the past copy of the website.

The src/ScreenshotGenerator.php file contains the code that takes a screenshot. Because this is contained within it's own PHP class / file, we can re-use this in future by just including it from wherever it's needed. See Wikipedia - DRY.

Finally, this ap makes use of a number of Open-source projects. These are listed below:

  • Symfony Console - Used to register a command-line app and get input from the user.
  • Symfony Process - Component used to run other command line processes from our code.
  • PhantomJs - A 'headless' browser that we use to load up webpages and take screenshots in our code.
  • Guzzle - A great HTTP client used to 'talk' to the Wayback Machine API.
  • Carbon - A simple PHP DateTime helper that makes working with timestamps super easy.

TODO

  • [] Update to check if URL exists before taking past/present screenshots
  • [] Add command option to only generate past screenshot (rather than present and past)
  • [] New command to take multiple past screenshots at the one time

Why Delorean?

In the feature film series Back to the Future, Dr. Emmett Brown builds a time machine based on an automobile; a DeLorean DMC-12.

Futher Reading.

Credits / License

Made by David Rushton, Developer at Papertank Limited Using the MIT License