+_(This is a rewrite of libremdb in Next.js. The information below corresponds to this branch only. I'll make this branch default sometime later.)_
+| | |
+| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| | 
|
---
-## Features
+## Some Features
- No ads or tracking
Browse any movie info without being tracked or bombarded by annoying ads.
-- No connection to IMDb
- All requests go through the backend; client never talks to IMDb except for a bunch of requests to `m.media-amazon.com` for images.
-- No JavaScript required
- Just a few linesof code(~30) to save theme preference, which itself is optional.
- Modern interface
Modern interface with curated colors supporting both dark and light themes.
- Responsive design
Be it your small mobile or big computer screen, it's fully responsive.
- Lightweight
_[Up movie page](https://imdb.com/title/tt1049413/)_
- | | libremdb | IMDb |
- | --------------- | -------- | ------ |
- | no. of requests | ~35 | ~280 |
- | data consumed | 1.35MB | 7.75MB |
+ (tested on Firefox v104; without scroll; simulated regular 4g)
+
+ | Network tab stats | libremdb | IMDb |
+ | ------------------------ | -------- | ------ |
+ | no. of requests | 22 | 180 |
+ | data transfered(gzipped) | 468KB | 1.88MB |
+ | load event fired in | 6.22s | 10.01s |
---
## Instances
-| Instance URL | Region | Notes |
-| -------------------------------- | ------------- | --------------------------------------------------------- |
-| https://libremdb.herokuapp.com | United States | Official; Hosted on Heroku |
-| https://libremdb.pussthecat.org | Germany | Operated by [PussTheCat.org](https://pussthecat.org/) |
-| https://libremdbeu.herokuapp.com | Europe | Operated by [toyboatcash](https://github.com/toyboatcash) |
-| https://lmdb.tokhmi.xyz/ | U.S. | Operated by [Tokhmi](https://tokhmi.xyz) |
-| https://libremdb.esmailelbob.xyz/ | Canada | Operated by [Esmail EL BoB](https://esmailelbob.xyz) |
-| http://libremdb.lqs5fjmajyp7rvp4qvyubwofzi6d4imua7vs237rkc4m5qogitqwrgyd.onion/ | Canada | Operated by [Esmail EL BoB](https://esmailelbob.xyz) |
+| Instance URL | Region | Notes |
+| ------------------------ | ------ | -------------- |
+| https://libremdb.iket.me | Canada | Operated by me |
---
-## FAQs
+## Questions you might have
- Why is it so slow?
Whenever you request info about a movie/show on libremdb, 4 trips are made(2 between your browser and libremdb's server, and 2 between libremdb's server and IMDb's server) instead of the usual 2 trips when you visit a website. For this reason there's a noticable delay. This is a bit of inconvenience you'll have to face should you wish to use this website.
- It doesn't have all routes.
- I think most of the people just check IMDb to get a quick glimpse of a movie/show. That's why there is just one route for now. However, I will try to implement other important routes if time allows. Keep an eye on [To-Do](#to-do) section.
+ I'll implement more with time :)
-- Why is it connecting to `m.media-amazon.com`?
- For now, images are directly served from amazon. If I have enough time in the future, I'll implement a way to serve the images from libremdb instead.
+- I see connection being made to some Amazon domains.
+ For now, images and videos are directly served from Amazon. If I have enough time in the future, I'll implement a way to serve the images from libremdb instead.
-- Will amazon track me then?
- They may log your IP address. I'd recommend using a VPN for mitigating this risk.
+- Will Amazon track me then?
+ They may log your IP address, useragent, and other such
+ identifiers. I'd recommend using a VPN, or accessing the website through TOR for mitigating this risk.
- Why not just use IMDb?
Refer to the [features section](#features) above.
@@ -66,12 +63,14 @@ Inspired by projects like [teddit](https://codeberg.org/teddit/teddit), [nitter]
## Privacy
-In short: libremdb doesn't collect any data at all.
+- Information collected:
+ None.
-- Data you directly provide: None.
-- Data you passively provide: A stack trace is logged to console on the server if you hit some error route.
-- Data stored in your browser: To remember theme preferences, the website stores a key named 'theme' in Local Storage provided by your browser. Apart from that, there is nothing stored in your browser.
-- Data collected by other services: libremdb connects to `m.media-amazon.com` for fetching images. So, Amazon might log your IP address. If you use the official instance which is deployed on Heroku, then Heroku might also log you IP address. You're advised to follow due precaution.
+- Information stored in your browser:
+ A key named 'theme' is stored in Local Storage provided by your browser, if you ever override the default theme. To remove it, go to site data settings, and clear the data for this website. To permamently disable libremdb from storing your theme prefrences, either turn off JavaScript or disable access to Local Storage for libremdb.
+
+- Information collected by other services:
+ libremdb connects to 'media-amazon.com' and 'media-imdb.com' for fetching images and videos. So, Amazon might log your IP address, and other information(such as http headers) sent by your browser.
---
@@ -80,21 +79,23 @@ In short: libremdb doesn't collect any data at all.
### soon
- [ ] add advanced search route
-- [ ] add did you know and reviews on movie info page
+- [x] add did you know and reviews on movie info page
- [ ] implement routes for reviews, quotes, goofs, trivia and crazy credits
### at a later stage
- [ ] use redis
-- [x] implement a better installation method
+- [ ] implement a better installation method
- [ ] serve images from libremdb itself
-- [ ] add a way to see trailer and other videos
+- [x] add a way to see trailer and other videos
- [ ] implement other trivial routes
---
## Installation
+As libremdb is made with Next.js, you can deploy it anywhere where Next.js is supported. Below are a few other methods:
+
### Manual
1. Install Node.js and Git.
@@ -104,11 +105,13 @@ In short: libremdb doesn't collect any data at all.
2. Clone and set up the repo.
```bash
- git clone https://github.com/zyachel/libremdb.git # replace gituhb.com with codeberg.org if you wish so.
+ git clone https://github.com/zyachel/libremdb.git # replace github.com with codeberg.org if you wish so.
cd libremdb
- cp config.env.template config.env # you can make necessary changes
- # if you use npm, change 'pnpm' to 'npm run' here as well as in package.json
+ # optional configuration
+ cp .env.local.example .env.local
+ # replace 'pnpm' with yarn or npm if you use those
pnpm install
+ pnpm build
pnpm start
```
@@ -116,7 +119,7 @@ libremdb will start running at http://localhost:3000.
### Docker
-There's a [docker image](https://github.com/PussTheCat-org/docker-libremdb-quay) made by [@TheFrenchGhosty](https://github.com/TheFrenchGhosty) for [PussTheCat.org's instance](https://libremdb.pussthecat.org). You can use that in case you wish to use docker.
+No image available yet.
---
@@ -124,21 +127,17 @@ There's a [docker image](https://github.com/PussTheCat-org/docker-libremdb-quay)
### Automatic redirection
-Use any of these extensions to automatically redirect IMDb URLs to libremdb:
-
- [Redirector](https://github.com/einaregilsson/Redirector)
config:
```
Description: redirect IMDb to libremdb
Example URL: https://www.imdb.com/title/tt0258463/?ref_=tt_sims_tt_t_4
- Include pattern: https?:\/\/(www\.)?imdb\.com\/title\/([^\?]*)
- Redirect to: https://libremdb.herokuapp.com/title/$2
+ Include pattern: https?:\/\/(www\.)?imdb\.com\/([^\?]*)
+ Redirect to: https://libremdb.iket.me/$2
Pattern type: Regular Expression
```
-- [LibRedirect](https://github.com/libredirect/libredirect/)
-
### Similar projects
- [Teddit](https://codeberg.org/teddit/teddit)
@@ -159,10 +158,7 @@ Use any of these extensions to automatically redirect IMDb URLs to libremdb:
## Contact
-| \[matrix\] | email |
-| :--------------------------------------------------------: | :------------------------------------------------------: |
-| 
| 
|
-| [@ninal:matrix.org](https://matrix.to/#/@ninal:matrix.org) | [aricla@protonmail.com](mailto:aricla@protonmail.com) |
+I'm availabe on [[matrix]](https://matrix.to/#/@ninal:matrix.org) and [email](mailto:aricla@protonmail.com) in case you wish to contact me personally.
---
diff --git a/app.js b/app.js
deleted file mode 100644
index d9e4cd0..0000000
--- a/app.js
+++ /dev/null
@@ -1,69 +0,0 @@
-const express = require('express');
-const path = require('path');
-const morgan = require('morgan');
-const helmet = require('helmet');
-const compression = require('compression');
-const dotenv = require('dotenv');
-
-const viewRouter = require('./routes/viewRoutes');
-const globalErrorHandler = require('./controllers/errorControllers');
-const { AppError } = require('./utils/errorUtils');
-
-const app = express();
-
-//---------------------------------------------------------------------------//
-// LOADING CONFIG FILE VARIABLES
-//---------------------------------------------------------------------------//
-dotenv.config({ path: './config.env' }); // loading .env variables
-
-//-------------------------------------------------------------------------//
-// GLOBAL MIDDLEWARES
-//-------------------------------------------------------------------------//
-
-app.use(compression()); // for compressing response bodies
-app.use(
- // for making the app more secure by setting some security headers(like CORS)
- helmet({
- contentSecurityPolicy: {
- directives: {
- // only allowing images from 'm.media-amazon.com' as crossorigin
- 'img-src': ["'self'", 'm.media-amazon.com'],
- },
- },
- // 'crossorigin' attribute is needed in the img tag where images are fetched from 'm.media-amazon.com' if the policy below is set to true. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cross-Origin-Embedder-Policy for more details
- crossOriginEmbedderPolicy: false,
- })
-);
-
-app.set('view engine', 'pug'); // setting pug as a view engine
-app.set('views', path.join(__dirname, 'views/pug')); // directory from where html template will be sourced
-
-app.use(
- express.static(path.join(__dirname, 'public'), {
- maxAge: process.env.CACHE_PERIOD || '1h',
- })
-); // directory from where files like css, images, fonts, will be sourced
-
-if (process.env.NODE_ENV === 'development') app.use(morgan('dev')); // for logging requests
-// app.use(express.json({ limit: '3mb' })); // for parsing json
-
-//-------------------------------------------------------------------------//
-// ROUTER MIDDLEWARES
-//-------------------------------------------------------------------------//
-// app.use('/api/v1/movies', movieRouter); // sub-router for movie related endpoints
-app.use('/', viewRouter); // for html pages
-
-//-------------------------------------------------------------------------//
-// GLOBAL ERROR HANDLING
-//-------------------------------------------------------------------------//
-app.all('*', (req, res, next) => {
- next(
- new AppError(
- `the route you requested(${req.originalUrl}) doesn't exist`,
- 404
- )
- );
-});
-app.use(globalErrorHandler); // handling errors in every middleware
-
-module.exports = app;
diff --git a/config.env.template b/config.env.template
deleted file mode 100644
index 991e280..0000000
--- a/config.env.template
+++ /dev/null
@@ -1,10 +0,0 @@
-# default port is 3000
-PORT=3000
-# url
-URL=http://localhost:3000
-# enviorment
-NODE_ENV=production
-# change image quality
-IMAGE_QUALITY=500
-# cache duration for static assets(eg: '2.5 days', 3600, 2m)
-CACHE_PERIOD=1h
\ No newline at end of file
diff --git a/controllers/errorControllers.js b/controllers/errorControllers.js
deleted file mode 100644
index a682190..0000000
--- a/controllers/errorControllers.js
+++ /dev/null
@@ -1,94 +0,0 @@
-const { AppError } = require('../utils/errorUtils');
-
-//----------------------------------------------------------------------------------------------------------//
-// ERROR HANDLING FUNCTIONS ACC TO ENVIRONMENTS
-//----------------------------------------------------------------------------------------------------------//
-// for errors during development
-const devErrorHandler = (err, req, res) => {
- req.originalUrl.startsWith('/api/')
- ? // 1) FOR API
- res.status(err.statusCode).json({
- status: err.status,
- message: err.message,
- stack: err.stack,
- err,
- })
- : // 2) FOR RENDERED PAGES
- res.render('error', {
- title: 'an error occured',
- page: 'error',
- message: err.message,
- statusCode: err.statusCode,
- stack: err.stack,
- });
-};
-
-// for errors during production
-const prodErrorHandler = (err, req, res) => {
- if (req.originalUrl.startsWith('/api/'))
- // 1) FOR API
- // for trusted, operational errors
- err.isOperational
- ? res
- .status(err.statusCode)
- .json({ status: err.status, message: err.message })
- : // for untrusted errors sending a generic message
- res
- .status(500)
- .json({ status: 'fail', message: 'something went wrong!' });
-
- // 2) FOR RENDERED PAGES
- err.isOperational
- ? res.render('error', {
- title: 'something went wrong',
- page: 'error',
- message: err.message,
- statusCode: err.statusCode,
- })
- : res.render('error', {
- title: 'an error occured',
- page: 'error',
- message: 'something went wrong!',
- statusCode: 500,
- });
- // err;
-};
-
-//-------------------------------------------------------------------------------------------------------------//
-// MAIN EXPRESS ERROR HANDLING MIDDLEWARE
-//-------------------------------------------------------------------------------------------------------------//
-const globalErrorHandler = (err, req, res, next) => {
- // setting some defaults on the error in case they don't exist already
- err.statusCode = err.statusCode || 500;
- err.status = err.status || 'error';
-
- // logging error to the console
- console.log('\x1b[31m%s\x1b[0m', '🔴️ ERROR:', err); // with red color
-
- // sending error to the client
- // for dev environment
- if (process.env.NODE_ENV === 'development') devErrorHandler(err, req, res);
- // for prod environment
- else if (process.env.NODE_ENV === 'production') {
- let error = { ...err };
-
- // marking some special errors as operational
- // axios errors
- if (err.isAxiosError) {
- // if connection can't be established to imdb for some reason
- if (err.code === 'ENETUNREACH' || err.code === 'ENOTFOUND')
- error = new AppError(
- 'there was some problem fetching data from IMDb',
- 500
- );
-
- // in case the url is wrong(like bad title id)
- if (err.response)
- error = new AppError(err.response.statusText, err.response.status);
- }
-
- prodErrorHandler(error, req, res);
- }
-};
-
-module.exports = globalErrorHandler;
diff --git a/controllers/viewControllers.js b/controllers/viewControllers.js
deleted file mode 100644
index 0f519c5..0000000
--- a/controllers/viewControllers.js
+++ /dev/null
@@ -1,73 +0,0 @@
-const { AppError, catchErrors } = require('../utils/errorUtils');
-// const { genres, popularGenres } = require('../utils/constants');
-const getMovie = require('../fetchers/movie');
-
-exports.overview = (req, res, next) => res.redirect(301, '/about');
-
-exports.about = catchErrors(async (req, res, next) => {
- res.render('about', { title: 'About', page: 'About' });
-});
-
-exports.privacy = catchErrors(async (req, res, next) => {
- res.render('privacy', { title: 'Privacy', page: 'Privacy' });
-});
-
-exports.contact = catchErrors(async (req, res, next) => {
- res.render('contact', { title: 'Contact', page: 'Contact' });
-});
-
-exports.similarProjects = catchErrors(async (req, res, next) => {
- res.render('similarProjects', {
- title: 'Similar Projects',
- page: 'Similar Projects',
- });
-});
-
-exports.movie = catchErrors(async (req, res, next) => {
- const movie = await getMovie(req.params.title, +process.env.IMAGE_QUALITY);
- res.render('movie', {
- movie,
- title: movie.basic.name,
- page: movie.basic.name,
- });
-});
-
-/*
-exports.searchGenres = catchErrors(async (req, res, next) => {
- // fetching top 10 rated movies to show in homepage
- let movies;
- const genresQueriedStr = req.query.genres;
- const genresQueriedArr = genresQueriedStr?.split(',');
-
- if (!genresQueriedArr) {
- movies = await moviesDataFetcher('sci-fi,action');
- return res.render('homepage', {
- title: 'Home Page',
- page: 'Home Page',
- movies: movies.slice(-10),
- genres,
- popularGenres,
- });
- }
-
- const numResults = +req.query.results || 10;
- const numPage = +req.query.page || 1;
- const resultsToskip = numResults * (numPage - 1);
-
- movies = await moviesDataFetcher(genresQueriedStr);
- movies = movies.slice(resultsToskip, resultsToskip + numResults);
- const totalNumResults = movies.length;
-
- if (!movies.length) return next(new AppError('no movies found', 404));
-
- const [curPage, totalPages] = [numPage, totalNumResults / numResults];
- res.render('movies', {
- title: genresQueriedArr.join(', '),
- page: 'Movies',
- genres: genresQueriedArr,
- movies,
- curPage,
- totalPages,
- });
-});
-*/
diff --git a/fetchers/movie.js b/fetchers/movie.js
deleted file mode 100644
index 19e6041..0000000
--- a/fetchers/movie.js
+++ /dev/null
@@ -1,256 +0,0 @@
-const cheerio = require('cheerio');
-const axiosInstance = require('../utils/axiosInstance');
-
-// cleans images links and adds custom quality(optional).
-const cleanLink = (link, quality = null) => {
- if (!link) return '';
- let cleanedLink = link.match(
- /https:\/\/m\.media-amazon\.com\/images\/M\/[^.]*/gm
- )?.[0];
- if (!cleanedLink) return '';
- cleanedLink += quality ? `.UX${quality}.jpeg` : '.jpeg';
- return cleanedLink;
-};
-
-const getMovie = async (title, quality = null) => {
- try {
- const res = await axiosInstance(`/title/${title}`);
-
- const $ = cheerio.load(res.data);
-
- // basic info
- const name = $('h1').text();
- const metadata = $('ul[data-testid=hero-title-block__metadata] li')
- .map((i, el) =>
- $(el).children().length ? $(el).children().first().text() : $(el).text()
- )
- .toArray();
- const rating = $('[data-testid=hero-rating-bar__aggregate-rating__score]')
- .children()
- .first()
- .text();
- const numVotes = $('[data-testid=hero-rating-bar__aggregate-rating__score]')
- .siblings()
- .last()
- .text();
- const popularity = $('[data-testid="hero-rating-bar__popularity__score"]')
- .first()
- .text();
- const plotBrief = $('span[data-testid=plot-xl]').contents().first().text();
- let poster = $('[data-testid="hero-media__poster"] img').attr('src');
- poster = cleanLink(poster, quality);
- const reviewScores = [];
- $(
- 'ul[data-testid="reviewContent-all-reviews"] li a span.three-Elements'
- ).each((i, el) =>
- reviewScores.push([
- $(el).children().first().text(),
- $(el).children().last().text(),
- ])
- );
-
- // media
- const images = $('section[data-testid="Photos"] .ipc-photo img')
- .map((i, el) => {
- let image = $(el).attr('src');
- return cleanLink(image, quality);
- })
- .toArray();
- const imagesLinkExternal = $('[data-testid=photos-title]').attr('href');
- const videoThumbnail = $('.ipc-slate__slate-image img').attr('src');
- const videoLinkExternal = $('.hero-media__slate-overlay').attr('href');
- const videosLinkExternal = $('[data-testid=videos-title]').attr('href');
-
- // cast
- const actors = $(
- 'section[data-testid="title-cast"] div[data-testid=title-cast-item]'
- )
- .map((i, el) => {
- const name = $(el)
- .find('a[data-testid="title-cast-item__actor"]')
- .text();
- let avatar = $(el).find('img').attr('src');
- avatar = cleanLink(avatar, quality);
- const characterName = $(el)
- .find('a[data-testid=cast-item-characters-link] span')
- .first()
- .text();
-
- return { name, avatar, characterName };
- })
- .toArray();
- const directors = $(
- 'section[data-testid=title-cast] ul li:nth-of-type(1) li'
- )
- .map((i, el) => $(el).find('a').text())
- .toArray();
- const writers = $('section[data-testid=title-cast] ul li:nth-of-type(2) li')
- .map((i, el) => $(el).find('a').text())
- .toArray();
-
- // storyline
- const plotExpanded = $(
- 'section[data-testid="Storyline"] [data-testid=storyline-plot-summary]'
- )
- .contents()
- .first()
- .text();
- const tagline = $(
- 'section[data-testid="Storyline"] [data-testid=storyline-taglines] li'
- )
- .first()
- .text();
- const genres = $(
- 'section[data-testid="Storyline"] [data-testid=storyline-genres] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
- const parentalGuidance = $(
- '[data-testid="storyline-certificate"] li'
- ).text();
-
- // reviews
- const reviewSummary = $(
- 'section[data-testid="UserReviews"] span[data-testid="review-summary"]'
- ).text();
- const reviewRating = $(
- 'section[data-testid="UserReviews"] div[data-testid="review-featured-header"]'
- )
- .children()
- .last()
- .text();
- const reviewComment = $(
- 'section[data-testid="UserReviews"] div[data-testid="review-overflow"]'
- ).text();
-
- // details
- const releaseDate = $(
- 'section[data-testid="Details"] li[data-testid="title-details-releasedate"] li'
- ).text();
- const countries = $(
- 'section[data-testid="Details"] li[data-testid="title-details-origin"] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
- const officialSite = $(
- 'section[data-testid="Details"] li[data-testid="title-details-officialsites"] li a'
- )
- .first()
- .attr('href');
- const languages = $(
- 'section[data-testid="Details"] li[data-testid="title-details-languages"] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
- const alternateTitle = $(
- 'section[data-testid="Details"] li[data-testid="title-details-akas"] li'
- )
- .first()
- .text();
- const filmingLocations = $(
- 'section[data-testid="Details"] li[data-testid="title-details-filminglocations"] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
- const companies = $(
- 'section[data-testid="Details"] li[data-testid="title-details-companies"] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
-
- // technical specs
- const runtime = $(
- 'section[data-testid="TechSpecs"] li[data-testid="title-techspec_runtime"] div'
- ).text();
- const color = $(
- 'section[data-testid="TechSpecs"] li[data-testid="title-techspec_color"] div'
- ).text();
- const aspectRatio = $(
- 'section[data-testid="TechSpecs"] li[data-testid="title-techspec_aspectratio"] div'
- ).text();
- const sound = $(
- 'section[data-testid="TechSpecs"] li[data-testid="title-techspec_soundmix"] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
-
- // boxoffice
- const budget = $(
- 'section[data-testid="BoxOffice"] [data-testid="title-boxoffice-section"] li[data-testid="title-boxoffice-budget"] li'
- ).text();
- const grossDomestic = $(
- 'section[data-testid="BoxOffice"] [data-testid="title-boxoffice-section"] li[data-testid="title-boxoffice-grossdomestic"] li'
- ).text();
- const openingWeekendDomestic = $(
- 'section[data-testid="BoxOffice"] [data-testid="title-boxoffice-section"] li[data-testid="title-boxoffice-openingweekenddomestic"] li'
- )
- .map((i, el) => $(el).text())
- .toArray();
- const grossWorldwide = $(
- 'section[data-testid="BoxOffice"] [data-testid="title-boxoffice-section"] li[data-testid="title-boxoffice-cumulativeworldwidegross"] li'
- ).text();
-
- // making data object
- const data = {
- basic: {
- name,
- poster,
- metadata,
- rating,
- numVotes,
- popularity,
- genres,
- plotBrief,
- directors,
- writers,
- },
- media: {
- poster,
- images,
- imagesLinkExternal,
- videoThumbnail,
- videoLinkExternal,
- videosLinkExternal,
- },
- topCast: { actors, directors, writers },
- storyline: { plotExpanded, tagline, genres, parentalGuidance },
- details: {
- releaseDate,
- countries,
- officialSite,
- languages,
- alternateTitle,
- filmingLocations,
- companies,
- },
- technicalSpecs: {
- runtime,
- color,
- aspectRatio,
- sound,
- },
- boxoffice: {
- budget,
- openingWeekendDomestic,
- grossDomestic,
- grossWorldwide,
- },
- reviews: {
- reviewScores,
- review: {
- reviewComment,
- reviewSummary,
- reviewRating,
- },
- },
- };
-
- // returning data
- return data;
- } catch (err) {
- console.log(err.response);
- throw err;
- }
-};
-
-module.exports = getMovie;
diff --git a/next-env.d.ts b/next-env.d.ts
new file mode 100644
index 0000000..4f11a03
--- /dev/null
+++ b/next-env.d.ts
@@ -0,0 +1,5 @@
+///