Ghost/core/server/data/meta/blog_logo.js
Aileen Nowak e19e91044d 🙇 Blog icon utils and publisher.logo for JSON-LD (#8297)
refs #8221, closes #7688, refs #7558

🙇  Improve meta data publisher logo behaviour
This is a follow-up PR for #8285.

Reasons: The code changes of #8285 caused error messages when falling back to the default `favicon.ico`, as the `image-size` tool doesn't support `ico` files.

This PR takes the logic to decide which logo needs to be listed in our schema into a new fn `blog_logo.js`. There we have now three decisions:
1. If we have a publication **logo**, we'll take that one
2. If we have no publication logo, but an **icon** we'll use this one.
3. If we have none of the above things, we fall back to our default `favicon.ico`

Additional, we're hard coding image dimensions for whenever the logo is an `.ico` file and built and extra decision to not call `image-size` when the dimension are already given.

I will create another follow-up PR, which checks the extension type for the file and offers it as a util.

🛠  Blog icon util

refs #7688

Serve functionality around the blog icon in its own util:
- getIconDimensions -> async function that takes the filepath of on ico file and returns its dimensions
- isIcoImageType -> returns true if file has `.ico` extension
- getIconType -> returns icon-type (`x-icon` or `png`)
- getIconUrl -> returns the absolut or relativ URL for the favicon: `[subdirectory or not]favicon.[ico or png]`

📖  Get .ico sizes for meta data & logo improvement

refs #7558
refs #8221

Use the new `blogIconUtil` in meta data to fetch the dimensions of `.ico` files.

Improvements for `publisher.logo`: We're now returning a hard-coded 'faked' image dimensions value to render an `imageObject` and prevent error our schema (Google structured data). As soon as an image (`.ico` or non-`.ico`) is too large, but - in case of non-`.ico` - a square format, be set the image-dimensions to 60px width and height. This reduces the chances of getting constantly error messages from Googles' webmaster tools.

- add getIconPath util
2017-04-11 18:32:06 +02:00

47 lines
1.7 KiB
JavaScript

var utils = require('../../utils'),
settingsCache = require('../../settings/cache'),
blogIconUtils = require('../../utils/blog-icon'),
Promise = require('bluebird'),
config = require('../../config'),
path = require('path');
function getBlogLogo() {
return new Promise(function getIconSize(resolve, reject) {
var logo = {},
filePath;
if (settingsCache.get('logo')) {
logo.url = utils.url.urlFor('image', {image: settingsCache.get('logo')}, true);
} else {
// CASE: no publication logo is updated. We can try to use either an uploaded publication icon
// or use the default one to make
// Google happy with it. See https://github.com/TryGhost/Ghost/issues/7558
logo.url = blogIconUtils.getIconUrl(true);
if (blogIconUtils.isIcoImageType(logo.url)) {
filePath = blogIconUtils.getIconPath();
// getIconDimensions needs the physical path of the ico file
if (settingsCache.get('icon')) {
// CASE: custom uploaded icon
filePath = path.join(config.getContentPath('images'), filePath);
}
return blogIconUtils.getIconDimensions(filePath).then(function (response) {
logo.dimensions = {
width: response.width,
height: response.height
};
return resolve(logo);
}).catch(function (err) {
return reject(err);
});
}
}
return resolve(logo);
});
}
module.exports = getBlogLogo;