@@ -33,41 +33,11 @@ Please [visit the website](https://crafatar.com) for details.
* Open an [issue](https://github.com/crafatar/crafatar/issues/) on GitHub
* You can [join IRC](https://webchat.esper.net/?channels=crafatar) in #crafatar on irc.esper.net.
-## Installation on Heroku
-[](https://heroku.com/deploy)
+# Installation
-## Installation on Dokku
-##### [dokku server]
-Install the [dokku-redis](https://github.com/ohardy/dokku-redis#redis-plugin-for-dokku) plugin.
-```shell
-dokku redis:start
-dokku apps:create crafatar
-dokku config:set crafatar BIND=0.0.0.0 PORT=5000
-```
-For persistent images and logs:
-```shell
-dokku docker-options:add crafatar deploy "-v /var/lib/crafatar/images:/app/images"
-dokku docker-options:add crafatar deploy "-v /var/log/crafatar:/app/logs"
-```
-If you want to listen on extra domains:
-```shell
-dokku domains crafatar:add example.com
-```
-##### [your machine]
-Add dokku remote and deploy!
-```shell
-git remote add dokku dokku@example.com:crafatar
-git push dokku master
-```
-
-## Installation on your machine
-* Use io.js
-* [Install](https://github.com/Automattic/node-canvas/wiki) Cairo.
-* `npm install`
-* Start `redis-server`
-* `npm start`
-* Access [http://localhost:3000](http://localhost:3000)
+Have a look at [crafatar/setup](https://github.com/crafatar/setup) to see how we set things up at Crafatar.
+For more info about local setup, Heroku, or Dokku please see [Installation](https://github.com/crafatar/crafatar/wiki/Installation) on the wiki.
## Tests
```shell
@@ -83,4 +53,4 @@ env VERBOSE_TEST=true npm test
It can be helpful to monitor redis commands to debug caching errors:
```shell
redis-cli monitor
-```
+```
\ No newline at end of file
diff --git a/app.json b/app.json
index 40bd9ac..939ca44 100644
--- a/app.json
+++ b/app.json
@@ -1,6 +1,6 @@
{
"name": "Crafatar",
- "description": "A Minecraft Avatar API written in NodeJS",
+ "description": "A blazing fast API for Minecraft faces!",
"repository": "https://github.com/crafatar/crafatar",
"keywords": [
"node",
@@ -10,10 +10,21 @@
],
"website": "https://crafatar.com/",
"env": {
- "HEROKU": "true",
- "BUILDPACK_URL": "https://github.com/mojodna/heroku-buildpack-multi.git#build-env"
+ "EPHEMERAL_STORAGE": {
+ "description": "Set to true if your storage is gone after deploying",
+ "required": false,
+ "value": true
+ }
},
"addons": [
"rediscloud"
+ ],
+ "buildpacks": [
+ {
+ "url": "https://github.com/mojodna/heroku-buildpack-cairo.git"
+ },
+ {
+ "url": "https://github.com/heroku/heroku-buildpack-nodejs.git"
+ }
]
-}
+}
\ No newline at end of file
diff --git a/config.example.js b/config.example.js
index be165d5..25b273e 100644
--- a/config.example.js
+++ b/config.example.js
@@ -1,36 +1,35 @@
var config = {
avatars: {
- min_size: 1, // for avatars
- max_size: 512, // for avatars; too big values might lead to slow response time or DoS
- default_size: 160 // for avatars; size to be used when no size given
+ min_size: 1, // for avatars
+ max_size: 512, // for avatars; too big values might lead to slow response time or DoS
+ default_size: 160 // for avatars; size to be used when no size given
},
renders: {
- min_scale: 1, // for 3D rendered skins
- max_scale: 10, // for 3D rendered skins; too big values might lead to slow response time or DoS
- default_scale: 6 // for 3D rendered skins; scale to be used when no scale given
+ min_scale: 1, // for 3D rendered skins
+ max_scale: 10, // for 3D rendered skins; too big values might lead to slow response time or DoS
+ default_scale: 6 // for 3D rendered skins; scale to be used when no scale given
},
cleaner: {
- interval: 1800, // interval seconds to check limits
- disk_limit: 10240, // min allowed free KB on disk to trigger image deletion
- redis_limit: 24576, // max allowed used KB on redis to trigger redis flush
- amount: 50000 // amount of skins for which all iamge types are deleted
+ interval: 600, // interval seconds to check limits
+ disk_limit: 524288, // min allowed free KB on disk to trigger image deletion
+ redis_limit: 24576, // max allowed used KB on redis to trigger redis flush
+ amount: 50000 // amount of skins for which all image types are deleted
},
directories: {
- faces: "images/faces/", // directory where faces are kept. should have trailing "/"
- helms: "images/helms/", // directory where helms are kept. should have trailing "/"
- skins: "images/skins/", // directory where skins are kept. should have trailing "/"
- renders: "images/renders/", // directory where rendered skins are kept. should have trailing "/"
- capes: "images/capes/" // directory where capes are kept. should have trailing "/"
+ faces: "./images/faces/", // directory where faces are kept. must have trailing "/"
+ helms: "./images/helms/", // directory where helms are kept. must have trailing "/"
+ skins: "./images/skins/", // directory where skins are kept. must have trailing "/"
+ renders: "./images/renders/", // directory where rendered skins are kept. must have trailing "/"
+ capes: "./images/capes/" // directory where capes are kept. must have trailing "/"
},
caching: {
- local: 1200, // seconds until we will check if user's skin changed. should be > 60 to comply with Mojang's rate limit
- browser: 3600 // seconds until browser will request image again
+ local: 1200, // seconds until we will check if user's skin changed. should be > 60 to comply with Mojang's rate limit
+ browser: 3600 // seconds until browser will request image again
},
server: {
- http_timeout: 1000, // ms until connection to Mojang is dropped
- debug_enabled: false, // enables logging.debug
- clusters: 1, // we recommend not using multiple clusters YET, see issue #80
- log_time: true // set to false if you use an external logger that provides timestamps
+ http_timeout: 2000, // ms until connection to Mojang is dropped
+ debug_enabled: false, // enables logging.debug & editing index page
+ log_time: true // set to false if you use an external logger that provides timestamps
}
};
diff --git a/lib/cache.js b/lib/cache.js
index b996d05..219e6af 100644
--- a/lib/cache.js
+++ b/lib/cache.js
@@ -1,18 +1,16 @@
var logging = require("./logging");
var node_redis = require("redis");
var config = require("../config");
-var path = require("path");
var url = require("url");
-var fs = require("fs");
var redis = null;
// sets up redis connection
-// flushes redis when running on heroku (files aren't kept between pushes)
+// flushes redis when using ephemeral storage (e.g. Heroku)
function connect_redis() {
logging.log("connecting to redis...");
// parse redis env
- var redis_env = (process.env.REDISCLOUD_URL || process.env.REDIS_URL);
+ var redis_env = process.env.REDISCLOUD_URL || process.env.REDIS_URL;
var redis_url = redis_env ? url.parse(redis_env) : {};
redis_url.port = redis_url.port || 6379;
redis_url.hostname = redis_url.hostname || "localhost";
@@ -23,39 +21,19 @@ function connect_redis() {
}
redis.on("ready", function() {
logging.log("Redis connection established.");
- if (process.env.HEROKU) {
- logging.log("Running on heroku, flushing redis");
+ if (process.env.EPHEMERAL_STORAGE) {
+ logging.log("Storage is ephemeral, flushing redis");
redis.flushall();
}
});
- redis.on("error", function (err) {
+ redis.on("error", function(err) {
logging.error(err);
});
- redis.on("end", function () {
+ redis.on("end", function() {
logging.warn("Redis connection lost!");
});
}
-// sets the date of the face file belonging to +skin_hash+ to now
-// the helms file is ignored because we only need 1 file to read/write from
-function update_file_date(rid, skin_hash) {
- if (skin_hash) {
- var face_path = path.join(__dirname, "..", config.directories.faces, skin_hash + ".png");
- fs.exists(face_path, function(exists) {
- if (exists) {
- var date = new Date();
- fs.utimes(face_path, date, date, function(err) {
- if (err) {
- logging.error(rid, "Error:", err.stack);
- }
- });
- } else {
- logging.error(rid, "tried to update", face_path + " date, but it does not exist");
- }
- });
- }
-}
-
var exp = {};
// returns the redis instance
@@ -92,20 +70,19 @@ exp.info = function(callback) {
});
};
-// sets the timestamp for +userId+ and its face file's (+hash+) date to the current time
+// sets the timestamp for +userId+
// if +temp+ is true, the timestamp is set so that the record will be outdated after 60 seconds
// these 60 seconds match the duration of Mojang's rate limit ban
// callback: error
-exp.update_timestamp = function(rid, userId, hash, temp, callback) {
- logging.debug(rid, "updating cache timestamp");
- var sub = temp ? (config.caching.local - 60) : 0;
+exp.update_timestamp = function(rid, userId, temp, callback) {
+ logging.debug(rid, "updating cache timestamp (" + temp + ")");
+ var sub = temp ? config.caching.local - 60 : 0;
var time = Date.now() - sub;
// store userId in lower case if not null
userId = userId && userId.toLowerCase();
redis.hmset(userId, "t", time, function(err) {
callback(err);
});
- update_file_date(rid, hash);
};
// create the key +userId+, store +skin_hash+, +cape_hash+, +slim+ and current time
@@ -114,12 +91,10 @@ exp.update_timestamp = function(rid, userId, hash, temp, callback) {
// +slim+ can be true (alex) or false (steve)
// +callback+ contans error
exp.save_hash = function(rid, userId, skin_hash, cape_hash, slim, callback) {
- logging.debug(rid, "caching skin:" + skin_hash + " cape:" + cape_hash);
-
+ logging.debug(rid, "caching skin:" + skin_hash + " cape:" + cape_hash + " slim:" + slim);
// store shorter null value instead of "null" string
skin_hash = skin_hash === null ? "" : skin_hash;
cape_hash = cape_hash === null ? "" : cape_hash;
-
// store userId in lower case if not null
userId = userId && userId.toLowerCase();
diff --git a/lib/cleaner.js b/lib/cleaner.js
index 53924c5..21c032d 100644
--- a/lib/cleaner.js
+++ b/lib/cleaner.js
@@ -20,10 +20,11 @@ function should_clean_redis(callback) {
} else {
try {
// logging.debug(info.toString());
- logging.debug("used mem:" + info.used_memory);
var used = parseInt(info.used_memory) / 1024;
- logging.log("RedisCleaner:", used + "KB used");
- callback(err, used >= config.cleaner.redis_limit);
+ var result = used >= config.cleaner.redis_limit;
+ var msg = "RedisCleaner: " + used + "KB used";
+ (result ? logging.log : logging.debug)(msg);
+ callback(err, result);
} catch(e) {
callback(e, false);
}
@@ -35,17 +36,19 @@ function should_clean_redis(callback) {
// callback: error, true|false
function should_clean_disk(callback) {
df({
- file: path.join(__dirname, "..", config.directories.faces),
+ file: config.directories.faces,
prefixMultiplier: "KiB",
isDisplayPrefixMultiplier: false,
precision: 2
- }, function (err, response) {
+ }, function(err, response) {
if (err) {
callback(err, false);
} else {
var available = response[0].available;
- logging.log("DiskCleaner:", available + "KB available");
- callback(err, available < config.cleaner.disk_limit);
+ var result = available < config.cleaner.disk_limit;
+ var msg = "DiskCleaner: " + available + "KB available";
+ (result ? logging.log : logging.debug)(msg);
+ callback(err, result);
}
});
}
@@ -71,28 +74,45 @@ exp.run = function() {
logging.error(err);
} else if (clean) {
logging.warn("DiskCleaner: Disk limit reached! Cleaning images now");
- var facesdir = path.join(__dirname, "..", config.directories.faces);
- var helmdir = path.join(__dirname, "..", config.directories.helms);
- var renderdir = path.join(__dirname, "..", config.directories.renders);
- var skindir = path.join(__dirname, "..", config.directories.skins);
- fs.readdir(facesdir, function (readerr, files) {
+
+ // hotfix for #139 | FIXME
+ logging.warn("DiskCleaner: Flushing Redis to prevent ENOENT");
+ redis.flushall();
+ // end hotfix
+
+ var skinsdir = config.directories.skins;
+ var capesdir = config.directories.capes;
+ var facesdir = config.directories.faces;
+ var helmsdir = config.directories.helms;
+ var rendersdir = config.directories.renders;
+ fs.readdir(skinsdir, function(readerr, files) {
if (!readerr) {
for (var i = 0, l = Math.min(files.length, config.cleaner.amount); i < l; i++) {
var filename = files[i];
if (filename[0] !== ".") {
fs.unlink(path.join(facesdir, filename), nil);
- fs.unlink(path.join(helmdir, filename), nil);
- fs.unlink(path.join(skindir, filename), nil);
+ fs.unlink(path.join(helmsdir, filename), nil);
+ fs.unlink(path.join(skinsdir, filename), nil);
}
}
}
});
- fs.readdir(renderdir, function (readerr, files) {
+ fs.readdir(rendersdir, function(readerr, files) {
if (!readerr) {
for (var j = 0, l = Math.min(files.length, config.cleaner.amount); j < l; j++) {
var filename = files[j];
if (filename[0] !== ".") {
- fs.unlink(renderdir + filename, nil);
+ fs.unlink(rendersdir + filename, nil);
+ }
+ }
+ }
+ });
+ fs.readdir(capesdir, function(readerr, files) {
+ if (!readerr) {
+ for (var j = 0, l = Math.min(files.length, config.cleaner.amount); j < l; j++) {
+ var filename = files[j];
+ if (filename[0] !== ".") {
+ fs.unlink(capesdir + filename, nil);
}
}
}
diff --git a/lib/helpers.js b/lib/helpers.js
index 4fcd367..5859b7a 100644
--- a/lib/helpers.js
+++ b/lib/helpers.js
@@ -25,14 +25,14 @@ function store_skin(rid, userId, profile, cache_details, callback) {
if (!err && url) {
var skin_hash = get_hash(url);
if (cache_details && cache_details.skin === skin_hash) {
- cache.update_timestamp(rid, userId, skin_hash, false, function(cache_err) {
+ cache.update_timestamp(rid, userId, false, function(cache_err) {
callback(cache_err, skin_hash, slim);
});
} else {
logging.debug(rid, "new skin hash:", skin_hash);
- var facepath = path.join(__dirname, "..", config.directories.faces, skin_hash + ".png");
- var helmpath = path.join(__dirname, "..", config.directories.helms, skin_hash + ".png");
- var skinpath = path.join(__dirname, "..", config.directories.skins, skin_hash + ".png");
+ var facepath = path.join(config.directories.faces, skin_hash + ".png");
+ var helmpath = path.join(config.directories.helms, skin_hash + ".png");
+ var skinpath = path.join(config.directories.skins, skin_hash + ".png");
fs.exists(facepath, function(exists) {
if (exists) {
logging.debug(rid, "skin already exists, not downloading");
@@ -42,14 +42,12 @@ function store_skin(rid, userId, profile, cache_details, callback) {
if (err1 || !img) {
callback(err1, null, slim);
} else {
- skins.save_image(img, skinpath, function(skin_err) {
+ skins.save_image(img, skinpath, function(skin_err, skin_img) {
if (skin_err) {
- logging.error(rid, skin_err);
callback(skin_err, null, slim);
} else {
skins.extract_face(img, facepath, function(err2) {
if (err2) {
- logging.error(rid, err2.stack);
callback(err2, null, slim);
} else {
logging.debug(rid, "face extracted");
@@ -82,12 +80,12 @@ function store_cape(rid, userId, profile, cache_details, callback) {
if (!err && url) {
var cape_hash = get_hash(url);
if (cache_details && cache_details.cape === cape_hash) {
- cache.update_timestamp(rid, userId, cape_hash, false, function(cache_err) {
+ cache.update_timestamp(rid, userId, false, function(cache_err) {
callback(cache_err, cape_hash);
});
} else {
logging.debug(rid, "new cape hash:", cape_hash);
- var capepath = path.join(__dirname, "..", config.directories.capes, cape_hash + ".png");
+ var capepath = path.join(config.directories.capes, cape_hash + ".png");
fs.exists(capepath, function(exists) {
if (exists) {
logging.debug(rid, "cape already exists, not downloading");
@@ -95,10 +93,9 @@ function store_cape(rid, userId, profile, cache_details, callback) {
} else {
networking.get_from(rid, url, function(img, response, net_err) {
if (net_err || !img) {
- logging.error(rid, net_err.stack);
callback(net_err, null);
} else {
- skins.save_image(img, capepath, function(skin_err) {
+ skins.save_image(img, capepath, function(skin_err, skin_img) {
logging.debug(rid, "cape saved");
callback(skin_err, cape_hash);
});
@@ -122,15 +119,18 @@ var requests = {
};
function push_request(userId, type, fun) {
- if (!requests[type][userId]) {
- requests[type][userId] = [];
+ // avoid special properties (e.g. 'constructor')
+ var userId_safe = "!" + userId;
+ if (!requests[type][userId_safe]) {
+ requests[type][userId_safe] = [];
}
- requests[type][userId].push(fun);
+ requests[type][userId_safe].push(fun);
}
// calls back all queued requests that match userId and type
function resume(userId, type, err, hash, slim) {
- var callbacks = requests[type][userId];
+ var userId_safe = "!" + userId;
+ var callbacks = requests[type][userId_safe];
if (callbacks) {
if (callbacks.length > 1) {
logging.debug(callbacks.length, "simultaneous requests for", userId);
@@ -145,17 +145,17 @@ function resume(userId, type, err, hash, slim) {
}
// it's still an empty array
- delete requests[type][userId];
+ delete requests[type][userId_safe];
}
}
// downloads the images for +userId+ while checking the cache
// status based on +cache_details+. +type+ specifies which
// image type should be called back on
-// callback: error, image hash
+// callback: error, image hash, slim
function store_images(rid, userId, cache_details, type, callback) {
var is_uuid = userId.length > 16;
- if (requests[type][userId]) {
+ if (requests[type]["!" + userId]) {
logging.debug(rid, "adding to request queue");
push_request(userId, type, callback);
} else {
@@ -229,8 +229,9 @@ exp.get_image_hash = function(rid, userId, type, callback) {
callback(null, (cached_hash ? 1 : 0), cached_hash, cache_details.slim);
} else {
// download image
- if (cache_details) {
+ if (cache_details && cache_details[type] !== undefined) {
logging.debug(rid, "userId cached, but too old");
+ logging.debug(rid, JSON.stringify(cache_details));
} else {
logging.debug(rid, "userId not cached");
}
@@ -238,7 +239,7 @@ exp.get_image_hash = function(rid, userId, type, callback) {
if (store_err) {
// we might have a cached hash although an error occured
// (e.g. Mojang servers not reachable, using outdated hash)
- cache.update_timestamp(rid, userId, cached_hash, true, function(err2) {
+ cache.update_timestamp(rid, userId, true, function(err2) {
callback(err2 || store_err, -1, cache_details && cached_hash, slim);
});
} else {
@@ -256,16 +257,16 @@ exp.get_image_hash = function(rid, userId, type, callback) {
// handles requests for +userId+ avatars with +size+
// callback: error, status, image buffer, skin hash
-// image is the user's face+helm when helm is true, or the face otherwise
+// image is the user's face+overlay when overlay is true, or the face otherwise
// for status, see get_image_hash
-exp.get_avatar = function(rid, userId, helm, size, callback) {
+exp.get_avatar = function(rid, userId, overlay, size, callback) {
exp.get_image_hash(rid, userId, "skin", function(err, status, skin_hash, slim) {
if (skin_hash) {
- var facepath = path.join(__dirname, "..", config.directories.faces, skin_hash + ".png");
- var helmpath = path.join(__dirname, "..", config.directories.helms, skin_hash + ".png");
+ var facepath = path.join(config.directories.faces, skin_hash + ".png");
+ var helmpath = path.join(config.directories.helms, skin_hash + ".png");
var filepath = facepath;
fs.exists(helmpath, function(exists) {
- if (helm && exists) {
+ if (overlay && exists) {
filepath = helmpath;
}
skins.resize_img(filepath, size, function(img_err, image) {
@@ -284,11 +285,11 @@ exp.get_avatar = function(rid, userId, helm, size, callback) {
};
// handles requests for +userId+ skins
-// callback: error, skin hash, status, image buffer
+// callback: error, skin hash, status, image buffer, slim
exp.get_skin = function(rid, userId, callback) {
exp.get_image_hash(rid, userId, "skin", function(err, status, skin_hash, slim) {
if (skin_hash) {
- var skinpath = path.join(__dirname, "..", config.directories.skins, skin_hash + ".png");
+ var skinpath = path.join(config.directories.skins, skin_hash + ".png");
fs.exists(skinpath, function(exists) {
if (exists) {
logging.debug(rid, "skin already exists, not downloading");
@@ -308,22 +309,22 @@ exp.get_skin = function(rid, userId, callback) {
};
// helper method used for file names
-// possible returned names based on +helm+ and +body+ are:
+// possible returned names based on +overlay+ and +body+ are:
// body, bodyhelm, head, headhelm
-function get_type(helm, body) {
+function get_type(overlay, body) {
var text = body ? "body" : "head";
- return helm ? text + "helm" : text;
+ return overlay ? text + "helm" : text;
}
// handles creations of 3D renders
// callback: error, skin hash, image buffer
-exp.get_render = function(rid, userId, scale, helm, body, callback) {
+exp.get_render = function(rid, userId, scale, overlay, body, callback) {
exp.get_skin(rid, userId, function(err, skin_hash, status, img, slim) {
if (!skin_hash) {
callback(err, status, skin_hash, null);
return;
}
- var renderpath = path.join(__dirname, "..", config.directories.renders, [skin_hash, scale, get_type(helm, body), slim ? "s" : "t"].join("-") + ".png");
+ var renderpath = path.join(config.directories.renders, [skin_hash, scale, get_type(overlay, body), slim ? "s" : "t"].join("-") + ".png");
fs.exists(renderpath, function(exists) {
if (exists) {
renders.open_render(rid, renderpath, function(render_err, rendered_img) {
@@ -335,17 +336,14 @@ exp.get_render = function(rid, userId, scale, helm, body, callback) {
callback(err, 0, skin_hash, null);
return;
}
- renders.draw_model(rid, img, scale, helm, body, slim, function(draw_err, drawn_img) {
+ renders.draw_model(rid, img, scale, overlay, body, slim, function(draw_err, drawn_img) {
if (draw_err) {
callback(draw_err, -1, skin_hash, null);
} else if (!drawn_img) {
callback(null, 0, skin_hash, null);
} else {
fs.writeFile(renderpath, drawn_img, "binary", function(fs_err) {
- if (fs_err) {
- logging.error(rid, fs_err.stack);
- }
- callback(null, 2, skin_hash, drawn_img);
+ callback(fs_err, 2, skin_hash, drawn_img);
});
}
});
@@ -362,7 +360,7 @@ exp.get_cape = function(rid, userId, callback) {
callback(err, null, status, null);
return;
}
- var capepath = path.join(__dirname, "..", config.directories.capes, cape_hash + ".png");
+ var capepath = path.join(config.directories.capes, cape_hash + ".png");
fs.exists(capepath, function(exists) {
if (exists) {
logging.debug(rid, "cape already exists, not downloading");
diff --git a/lib/logging.js b/lib/logging.js
index b39844f..668bd89 100644
--- a/lib/logging.js
+++ b/lib/logging.js
@@ -1,4 +1,3 @@
-var cluster = require("cluster");
var config = require("../config");
var exp = {};
@@ -18,10 +17,9 @@ function join_args(args) {
function log(level, args, logger) {
logger = logger || console.log;
var time = config.server.log_time ? new Date().toISOString() + " " : "";
- var clid = (cluster.worker && cluster.worker.id || "M");
var lines = join_args(args).split("\n");
for (var i = 0, l = lines.length; i < l; i++) {
- logger(time + clid, level + ":", lines[i]);
+ logger(time, level + ":", lines[i]);
}
}
diff --git a/lib/networking.js b/lib/networking.js
index 0aca57a..cbeba48 100644
--- a/lib/networking.js
+++ b/lib/networking.js
@@ -76,35 +76,56 @@ exp.get_from_options = function(rid, url, options, callback) {
},
timeout: config.server.http_timeout,
followRedirect: false,
- encoding: (options.encoding || null),
+ encoding: options.encoding || null,
}, function(error, response, body) {
// log url + code + description
var code = response && response.statusCode;
- if (error) {
- logging.error(rid, url, error);
- } else {
- var logfunc = code && code < 405 ? logging.debug : logging.warn;
- logfunc(rid, url, code, http_code[code]);
+
+ var logfunc = code && code < 405 ? logging.debug : logging.warn;
+ logfunc(rid, url, code || error && error.code, http_code[code]);
+
+ // not necessarily used
+ var e = new Error(code);
+ e.name = "HTTP";
+ e.code = "HTTPERROR";
+
+ switch (code) {
+ case 200:
+ case 301:
+ case 302: // never seen, but mojang might use it in future
+ case 307: // never seen, but mojang might use it in future
+ case 308: // never seen, but mojang might use it in future
+ // these are okay
+ break;
+ case 204: // no content, used like 404 by mojang. making sure it really has no content
+ case 404:
+ // can be cached as null
+ body = null;
+ break;
+ case 429: // this shouldn't usually happen, but occasionally does
+ case 500:
+ case 503:
+ case 504:
+ // we don't want to cache this
+ error = error || e;
+ body = null;
+ break;
+ default:
+ if (!error) {
+ // Probably 500 or the likes
+ logging.error(rid, "Unexpected response:", code, body);
+ }
+ error = error || e;
+ body = null;
+ break;
}
- // 200 or 301 depending on content type
- if (!error && (code === 200 || code === 301)) {
- // response received successfully
- callback(body, response, null);
- } else if (error) {
- callback(body || null, response, error);
- } else if (code === 404 || code === 204) {
- // page does not exist
- callback(null, response, null);
- } else if (code === 429) {
- // Too Many Requests exception - code 429
- // cause error so the image will not be cached
- callback(body || null, response, (error || "TooManyRequests"));
- } else {
- logging.error(rid, " Unknown reply:");
- logging.error(rid, JSON.stringify(response));
- callback(body || null, response, error);
+ if (body && !body.length) {
+ // empty response
+ body = null;
}
+
+ callback(body, response, error);
});
};
@@ -161,7 +182,18 @@ exp.get_profile = function(rid, uuid, callback) {
callback(null, null);
} else {
exp.get_from_options(rid, session_url + uuid, { encoding: "utf8" }, function(body, response, err) {
- callback(err || null, (body !== null ? JSON.parse(body) : null));
+ try {
+ body = body ? JSON.parse(body) : null;
+ callback(err || null, body);
+ } catch(e) {
+ if (e instanceof SyntaxError) {
+ logging.warn(rid, "Failed to parse JSON", e);
+ logging.debug(rid, body);
+ callback(err || null, null);
+ } else {
+ throw e;
+ }
+ }
});
}
};
@@ -187,11 +219,10 @@ exp.save_texture = function(rid, tex_hash, outpath, callback) {
var textureurl = textures_url + tex_hash;
exp.get_from(rid, textureurl, function(img, response, err) {
if (err) {
- logging.error(rid, "error while downloading texture");
callback(err, response, null);
} else {
- skins.save_image(img, outpath, function(img_err) {
- callback(img_err, response, img);
+ skins.save_image(img, outpath, function(img_err, saved_img) {
+ callback(img_err, response, saved_img);
});
}
});
diff --git a/lib/public/images/akliz.png b/lib/public/images/akliz.png
index 3783439..ba4d2a6 100644
Binary files a/lib/public/images/akliz.png and b/lib/public/images/akliz.png differ
diff --git a/lib/public/images/alex.png b/lib/public/images/mhf_alex.png
similarity index 100%
rename from lib/public/images/alex.png
rename to lib/public/images/mhf_alex.png
diff --git a/lib/public/images/alex_skin.png b/lib/public/images/mhf_alex_skin.png
similarity index 100%
rename from lib/public/images/alex_skin.png
rename to lib/public/images/mhf_alex_skin.png
diff --git a/lib/public/images/steve.png b/lib/public/images/mhf_steve.png
similarity index 100%
rename from lib/public/images/steve.png
rename to lib/public/images/mhf_steve.png
diff --git a/lib/public/images/steve_skin.png b/lib/public/images/mhf_steve_skin.png
similarity index 100%
rename from lib/public/images/steve_skin.png
rename to lib/public/images/mhf_steve_skin.png
diff --git a/lib/public/images/twitter.png b/lib/public/images/twitter.png
deleted file mode 100644
index 39c805a..0000000
Binary files a/lib/public/images/twitter.png and /dev/null differ
diff --git a/lib/public/javascript/crafatar.js b/lib/public/javascript/crafatar.js
new file mode 100644
index 0000000..ee828b8
--- /dev/null
+++ b/lib/public/javascript/crafatar.js
@@ -0,0 +1,60 @@
+var valid_user_id = /^([0-9a-f-A-F-]{32,36}|[a-zA-Z0-9_]{1,16})$/; // uuid|username
+var xhr = new XMLHttpRequest();
+
+xhr.onload = function() {
+ var response = JSON.parse(xhr.responseText);
+ var status = {};
+ response.map(function(elem) {
+ var key = Object.keys(elem)[0];
+ status[key] = elem[key];
+ });
+
+ var textures = status["textures.minecraft.net"] !== "green";
+ var session = status["sessionserver.mojang.com"] !== "green";
+ var skins = status["skins.minecraft.net"] !== "green";
+ var error = null;
+
+ if (textures || session && skins) {
+ error = "all";
+ } else if (skins) {
+ error = "username";
+ } else if (session) {
+ error = "UUID";
+ }
+
+ if (error) {
+ var warn = document.createElement("div");
+ warn.setAttribute("class", "alert alert-warning");
+ warn.setAttribute("role", "alert");
+ warn.innerHTML = "
+ 
+ Accepted modifiers: size, overlay, default.
+
+ Accepted modifiers: scale, overlay, default.
+ Please note that renders are still beta and have some issues. New renders are in progress!
+
+ Accepted modifiers: scale, overlay, default.
+ Please note that renders are still beta and have some issues. New renders are in progress!
+
Accepted modifiers: default.
+Accepted modifiers: default.
+
+ In the examples above, you can generally use usernames instead of uuid. However, apart from the special cases MHF_Steve and MHF_Alex this is discouraged as explained below.
+ You can append .png or any other file extension to the URL path if you like to, but all images are PNG.
+
+ Attribution is not required, but it is encouraged.
+ If you want to show some support for this (free!) service, place a notice like this somewhere:
+
+ Thank you to <a href="https://crafatar.com">Crafatar</a> for providing avatars.
+
+
+ You can tweak images using query string parameters.
+ Example: <%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?size=4&default=MHF_Steve&overlay
+
<%= config.avatars.min_size %> - <%= config.avatars.max_size %>
+ <%= config.renders.min_scale %> - <%= config.renders.max_scale %>
+ true. This option was previously known as helm.
+ MHF_Steve or MHF_Alex, depending on the requested UUID. All usernames default to MHF_Steve.
+ UUIDs may be any valid Mojang UUID in the blank or dashed format.
+Malformed UUIDs are rejected.
+
+ We strongly advise you to use UUIDs instead of usernames! UUIDs never change while usernames do.
+ Looking up players by username has officially been deprecated by Mojang ever since UUIDs were introduced.
+ Crafatar uses a legacy API which updates very slowly to retrieve skins for usernames.
+ Skins come without any details, including whether a player uses the Alex or Steve skin model.
+ Additionally, Mojang has stated that this legacy interface may be disabled anytime, causing all requests to fail.
+
Malformed usernames are rejected.
+
+ Crafatar checks for skin updates every <%= config.caching.local / 60 %> minutes.
+ Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.
+ In addition, CloudFlare caches up to 2 hours on a per-url basis.
+
When you changed your skin you can try clearing your browser cache to see the change faster.
+Crafatar supports Cross-Origin Resource Sharing, so you can make AJAX request from other sites!
+
+ Responses come with some custom HTTP headers, useful for debugging.
+ Please note that these headers may be cached by CloudFlare.
+
See also: what users say about Crafatar
+