fca-orion-api 1.0.0

package/src/sendMessage.js

@@ -0,0 +1,477 @@
+"use strict";
+
+const utils = require("../utils");
+const log = require("npmlog");
+
+const allowedProperties = {
+	attachment: true,
+	url: true,
+	sticker: true,
+	emoji: true,
+	emojiSize: true,
+	body: true,
+	mentions: true,
+	location: true
+};
+
+function removeSpecialChar(inputString) { // remove char banned by facebook
+	if (typeof inputString !== "string")
+		return inputString;
+	// Convert string to Buffer
+	const buffer = Buffer.from(inputString, 'utf8');
+
+	// Filter buffer start with ef b8 8f
+	let filteredBuffer = Buffer.alloc(0);
+	for (let i = 0; i < buffer.length; i++) {
+		if (buffer[i] === 0xEF && buffer[i + 1] === 0xB8 && buffer[i + 2] === 0x8F) {
+			i += 2; // Skip 3 bytes of buffer starting with ef b8 8f
+		} else {
+			filteredBuffer = Buffer.concat([filteredBuffer, buffer.slice(i, i + 1)]);
+		}
+	}
+
+	// Convert filtered buffer to string
+	const convertedString = filteredBuffer.toString('utf8');
+
+	return convertedString;
+}
+
+module.exports = function (defaultFuncs, api, ctx) {
+	function uploadAttachment(attachments, callback) {
+		const uploads = [];
+
+		// create an array of promises
+		for (let i = 0; i < attachments.length; i++) {
+			if (!utils.isReadableStream(attachments[i])) {
+				throw {
+					error:
+						"Attachment should be a readable stream and not " +
+						utils.getType(attachments[i]) +
+						"."
+				};
+			}
+
+			const form = {
+				upload_1024: attachments[i],
+				voice_clip: "true"
+			};
+
+			uploads.push(
+				defaultFuncs
+					.postFormData(
+						"https://upload.facebook.com/ajax/mercury/upload.php",
+						ctx.jar,
+						form,
+						{}
+					)
+					.then(utils.parseAndCheckLogin(ctx, defaultFuncs))
+					.then(function (resData) {
+						if (resData.error) {
+							throw resData;
+						}
+
+						// We have to return the data unformatted unless we want to change it
+						// back in sendMessage.
+						return resData.payload.metadata[0];
+					})
+			);
+		}
+
+		// resolve all promises
+		Promise
+			.all(uploads)
+			.then(function (resData) {
+				callback(null, resData);
+			})
+			.catch(function (err) {
+				log.error("uploadAttachment", err);
+				return callback(err);
+			});
+	}
+
+	function getUrl(url, callback) {
+		const form = {
+			image_height: 960,
+			image_width: 960,
+			uri: url
+		};
+
+		defaultFuncs
+			.post(
+				"https://www.facebook.com/message_share_attachment/fromURI/",
+				ctx.jar,
+				form
+			)
+			.then(utils.parseAndCheckLogin(ctx, defaultFuncs))
+			.then(function (resData) {
+				if (resData.error) {
+					return callback(resData);
+				}
+
+				if (!resData.payload) {
+					return callback({ error: "Invalid url" });
+				}
+
+				callback(null, resData.payload.share_data.share_params);
+			})
+			.catch(function (err) {
+				log.error("getUrl", err);
+				return callback(err);
+			});
+	}
+
+	function sendContent(form, threadID, isSingleUser, messageAndOTID, callback) {
+		// There are three cases here:
+		// 1. threadID is of type array, where we're starting a new group chat with users
+		//    specified in the array.
+		// 2. User is sending a message to a specific user.
+		// 3. No additional form params and the message goes to an existing group chat.
+		if (utils.getType(threadID) === "Array") {
+			for (let i = 0; i < threadID.length; i++) {
+				form["specific_to_list[" + i + "]"] = "fbid:" + threadID[i];
+			}
+			form["specific_to_list[" + threadID.length + "]"] = "fbid:" + (ctx.i_userID || ctx.userID);
+			form["client_thread_id"] = "root:" + messageAndOTID;
+			log.info("sendMessage", "Sending message to multiple users: " + threadID);
+		} else {
+			// This means that threadID is the id of a user, and the chat
+			// is a single person chat
+			if (isSingleUser) {
+				form["specific_to_list[0]"] = "fbid:" + threadID;
+				form["specific_to_list[1]"] = "fbid:" + (ctx.i_userID || ctx.userID);
+				form["other_user_fbid"] = threadID;
+			} else {
+				form["thread_fbid"] = threadID;
+			}
+		}
+
+		if (ctx.globalOptions.pageID) {
+			form["author"] = "fbid:" + ctx.globalOptions.pageID;
+			form["specific_to_list[1]"] = "fbid:" + ctx.globalOptions.pageID;
+			form["creator_info[creatorID]"] = ctx.i_userID || ctx.userID;
+			form["creator_info[creatorType]"] = "direct_admin";
+			form["creator_info[labelType]"] = "sent_message";
+			form["creator_info[pageID]"] = ctx.globalOptions.pageID;
+			form["request_user_id"] = ctx.globalOptions.pageID;
+			form["creator_info[profileURI]"] =
+				"https://www.facebook.com/profile.php?id=" + (ctx.i_userID || ctx.userID);
+		}
+
+		defaultFuncs
+			.post("https://www.facebook.com/messaging/send/", ctx.jar, form)
+			.then(utils.parseAndCheckLogin(ctx, defaultFuncs))
+			.then(function (resData) {
+				if (!resData) {
+					return callback({ error: "Send message failed." });
+				}
+
+				if (resData.error) {
+					if (resData.error === 1545012) {
+						log.warn(
+							"sendMessage",
+							"Got error 1545012. This might mean that you're not part of the conversation " +
+							threadID
+						);
+					}
+					else {
+						log.error("sendMessage", resData);
+					}
+					return callback(resData);
+				}
+
+				const messageInfo = resData.payload.actions.reduce(function (p, v) {
+					return (
+						{
+							threadID: v.thread_fbid,
+							messageID: v.message_id,
+							timestamp: v.timestamp
+						} || p
+					);
+				}, null);
+
+				return callback(null, messageInfo);
+			})
+			.catch(function (err) {
+				log.error("sendMessage", err);
+				if (utils.getType(err) == "Object" && err.error === "Not logged in.") {
+					ctx.loggedIn = false;
+				}
+				return callback(err);
+			});
+	}
+
+	function send(form, threadID, messageAndOTID, callback, isGroup) {
+		// We're doing a query to this to check if the given id is the id of
+		// a user or of a group chat. The form will be different depending
+		// on that.
+		if (utils.getType(threadID) === "Array") {
+			sendContent(form, threadID, false, messageAndOTID, callback);
+		} else {
+			if (utils.getType(isGroup) != "Boolean") {
+				// Removed the use of api.getUserInfo() in the old version to reduce account lockout
+				sendContent(form, threadID, threadID.toString().length < 16, messageAndOTID, callback);
+			} else {
+				sendContent(form, threadID, !isGroup, messageAndOTID, callback);
+			}
+		}
+	}
+
+	function handleUrl(msg, form, callback, cb) {
+		if (msg.url) {
+			form["shareable_attachment[share_type]"] = "100";
+			getUrl(msg.url, function (err, params) {
+				if (err) {
+					return callback(err);
+				}
+
+				form["shareable_attachment[share_params]"] = params;
+				cb();
+			});
+		} else {
+			cb();
+		}
+	}
+
+	function handleLocation(msg, form, callback, cb) {
+		if (msg.location) {
+			if (msg.location.latitude == null || msg.location.longitude == null) {
+				return callback({ error: "location property needs both latitude and longitude" });
+			}
+
+			form["location_attachment[coordinates][latitude]"] = msg.location.latitude;
+			form["location_attachment[coordinates][longitude]"] = msg.location.longitude;
+			form["location_attachment[is_current_location]"] = !!msg.location.current;
+		}
+
+		cb();
+	}
+
+	function handleSticker(msg, form, callback, cb) {
+		if (msg.sticker) {
+			form["sticker_id"] = msg.sticker;
+		}
+		cb();
+	}
+
+	function handleEmoji(msg, form, callback, cb) {
+		if (msg.emojiSize != null && msg.emoji == null) {
+			return callback({ error: "emoji property is empty" });
+		}
+		if (msg.emoji) {
+			if (msg.emojiSize == null) {
+				msg.emojiSize = "medium";
+			}
+			if (
+				msg.emojiSize != "small" &&
+				msg.emojiSize != "medium" &&
+				msg.emojiSize != "large"
+			) {
+				return callback({ error: "emojiSize property is invalid" });
+			}
+			if (form["body"] != null && form["body"] != "") {
+				return callback({ error: "body is not empty" });
+			}
+			form["body"] = msg.emoji;
+			form["tags[0]"] = "hot_emoji_size:" + msg.emojiSize;
+		}
+		cb();
+	}
+
+	function handleAttachment(msg, form, callback, cb) {
+		if (msg.attachment) {
+			form["image_ids"] = [];
+			form["gif_ids"] = [];
+			form["file_ids"] = [];
+			form["video_ids"] = [];
+			form["audio_ids"] = [];
+
+			if (utils.getType(msg.attachment) !== "Array") {
+				msg.attachment = [msg.attachment];
+			}
+
+			uploadAttachment(msg.attachment, function (err, files) {
+				if (err) {
+					return callback(err);
+				}
+
+				files.forEach(function (file) {
+					const key = Object.keys(file);
+					const type = key[0]; // image_id, file_id, etc
+					form["" + type + "s"].push(file[type]); // push the id
+				});
+				cb();
+			});
+		} else {
+			cb();
+		}
+	}
+
+	function handleMention(msg, form, callback, cb) {
+		if (msg.mentions) {
+			for (let i = 0; i < msg.mentions.length; i++) {
+				const mention = msg.mentions[i];
+
+				const tag = mention.tag;
+				if (typeof tag !== "string") {
+					return callback({ error: "Mention tags must be strings." });
+				}
+
+				const offset = msg.body.indexOf(tag, mention.fromIndex || 0);
+
+				if (offset < 0) {
+					log.warn(
+						"handleMention",
+						'Mention for "' + tag + '" not found in message string.'
+					);
+				}
+
+				if (mention.id == null) {
+					log.warn("handleMention", "Mention id should be non-null.");
+				}
+
+				const id = mention.id || 0;
+				form["profile_xmd[" + i + "][offset]"] = offset;
+				form["profile_xmd[" + i + "][length]"] = tag.length;
+				form["profile_xmd[" + i + "][id]"] = id;
+				form["profile_xmd[" + i + "][type]"] = "p";
+			}
+		}
+		cb();
+	}
+
+	return function sendMessage(msg, threadID, callback, replyToMessage, isGroup) {
+		typeof isGroup == "undefined" ? isGroup = null : "";
+		if (
+			!callback &&
+			(utils.getType(threadID) === "Function" ||
+				utils.getType(threadID) === "AsyncFunction")
+		) {
+			return threadID({ error: "Pass a threadID as a second argument." });
+		}
+		if (
+			!replyToMessage &&
+			utils.getType(callback) === "String"
+		) {
+			replyToMessage = callback;
+			callback = function () { };
+		}
+
+		let resolveFunc = function () { };
+		let rejectFunc = function () { };
+		const returnPromise = new Promise(function (resolve, reject) {
+			resolveFunc = resolve;
+			rejectFunc = reject;
+		});
+
+		if (!callback) {
+			callback = function (err, friendList) {
+				if (err) {
+					return rejectFunc(err);
+				}
+				resolveFunc(friendList);
+			};
+		}
+
+		const msgType = utils.getType(msg);
+		const threadIDType = utils.getType(threadID);
+		const messageIDType = utils.getType(replyToMessage);
+
+		if (msgType !== "String" && msgType !== "Object") {
+			return callback({
+				error:
+					"Message should be of type string or object and not " + msgType + "."
+			});
+		}
+
+		// Changing this to accomodate an array of users
+		if (
+			threadIDType !== "Array" &&
+			threadIDType !== "Number" &&
+			threadIDType !== "String"
+		) {
+			return callback({
+				error:
+					"ThreadID should be of type number, string, or array and not " +
+					threadIDType +
+					"."
+			});
+		}
+
+		if (replyToMessage && messageIDType !== 'String') {
+			return callback({
+				error:
+					"MessageID should be of type string and not " +
+					threadIDType +
+					"."
+			});
+		}
+
+		if (msgType === "String") {
+			msg = { body: msg };
+		}
+
+		if (utils.getType(msg.body) === "String") {
+			msg.body = removeSpecialChar(msg.body);
+		}
+
+		const disallowedProperties = Object.keys(msg).filter(
+			prop => !allowedProperties[prop]
+		);
+		if (disallowedProperties.length > 0) {
+			return callback({
+				error: "Dissallowed props: `" + disallowedProperties.join(", ") + "`"
+			});
+		}
+
+		const messageAndOTID = utils.generateOfflineThreadingID();
+
+		const form = {
+			client: "mercury",
+			action_type: "ma-type:user-generated-message",
+			author: "fbid:" + (ctx.i_userID || ctx.userID),
+			timestamp: Date.now(),
+			timestamp_absolute: "Today",
+			timestamp_relative: utils.generateTimestampRelative(),
+			timestamp_time_passed: "0",
+			is_unread: false,
+			is_cleared: false,
+			is_forward: false,
+			is_filtered_content: false,
+			is_filtered_content_bh: false,
+			is_filtered_content_account: false,
+			is_filtered_content_quasar: false,
+			is_filtered_content_invalid_app: false,
+			is_spoof_warning: false,
+			source: "source:chat:web",
+			"source_tags[0]": "source:chat",
+			body: msg.body ? msg.body.toString() : "",
+			html_body: false,
+			ui_push_phase: "V3",
+			status: "0",
+			offline_threading_id: messageAndOTID,
+			message_id: messageAndOTID,
+			threading_id: utils.generateThreadingID(ctx.clientID),
+			"ephemeral_ttl_mode:": "0",
+			manual_retry_cnt: "0",
+			has_attachment: !!(msg.attachment || msg.url || msg.sticker),
+			signatureID: utils.getSignatureID(),
+			replied_to_message_id: replyToMessage
+		};
+
+		handleLocation(msg, form, callback, () =>
+			handleSticker(msg, form, callback, () =>
+				handleAttachment(msg, form, callback, () =>
+					handleUrl(msg, form, callback, () =>
+						handleEmoji(msg, form, callback, () =>
+							handleMention(msg, form, callback, () =>
+								send(form, threadID, messageAndOTID, callback, isGroup)
+							)
+						)
+					)
+				)
+			)
+		);
+
+		return returnPromise;
+	};
+};

package/src/sendTypingIndicator.js

@@ -0,0 +1,103 @@
+"use strict";
+
+const utils = require("../utils");
+const log = require("npmlog");
+
+module.exports = function (defaultFuncs, api, ctx) {
+	function makeTypingIndicator(typ, threadID, callback, isGroup) {
+		const form = {
+			typ: +typ,
+			to: "",
+			source: "mercury-chat",
+			thread: threadID
+		};
+
+		// Check if thread is a single person chat or a group chat
+		// More info on this is in api.sendMessage
+		if (utils.getType(isGroup) == "Boolean") {
+			if (!isGroup) {
+				form.to = threadID;
+			}
+			defaultFuncs
+				.post("https://www.facebook.com/ajax/messaging/typ.php", ctx.jar, form)
+				.then(utils.parseAndCheckLogin(ctx, defaultFuncs))
+				.then(function (resData) {
+					if (resData.error) {
+						throw resData;
+					}
+
+					return callback();
+				})
+				.catch(function (err) {
+					log.error("sendTypingIndicator", err);
+					if (utils.getType(err) == "Object" && err.error === "Not logged in") {
+						ctx.loggedIn = false;
+					}
+					return callback(err);
+				});
+		} else {
+			api.getUserInfo(threadID, function (err, res) {
+				if (err) {
+					return callback(err);
+				}
+
+				// If id is single person chat
+				if (Object.keys(res).length > 0) {
+					form.to = threadID;
+				}
+
+				defaultFuncs
+					.post("https://www.facebook.com/ajax/messaging/typ.php", ctx.jar, form)
+					.then(utils.parseAndCheckLogin(ctx, defaultFuncs))
+					.then(function (resData) {
+						if (resData.error) {
+							throw resData;
+						}
+
+						return callback();
+					})
+					.catch(function (err) {
+						log.error("sendTypingIndicator", err);
+						if (utils.getType(err) == "Object" && err.error === "Not logged in.") {
+							ctx.loggedIn = false;
+						}
+						return callback(err);
+					});
+			});
+		}
+	}
+
+	return function sendTypingIndicator(threadID, callback, isGroup) {
+		if (
+			utils.getType(callback) !== "Function" &&
+			utils.getType(callback) !== "AsyncFunction"
+		) {
+			if (callback) {
+				log.warn(
+					"sendTypingIndicator",
+					"callback is not a function - ignoring."
+				);
+			}
+			callback = () => { };
+		}
+
+		makeTypingIndicator(true, threadID, callback, isGroup);
+
+		return function end(cb) {
+			if (
+				utils.getType(cb) !== "Function" &&
+				utils.getType(cb) !== "AsyncFunction"
+			) {
+				if (cb) {
+					log.warn(
+						"sendTypingIndicator",
+						"callback is not a function - ignoring."
+					);
+				}
+				cb = () => { };
+			}
+
+			makeTypingIndicator(false, threadID, cb, isGroup);
+		};
+	};
+};

package/src/setMessageReaction.js

@@ -0,0 +1,121 @@
+"use strict";
+
+const utils = require("../utils");
+const log = require("npmlog");
+
+module.exports = function (defaultFuncs, api, ctx) {
+	return function setMessageReaction(reaction, messageID, callback, forceCustomReaction) {
+		let resolveFunc = function () { };
+		let rejectFunc = function () { };
+		const returnPromise = new Promise(function (resolve, reject) {
+			resolveFunc = resolve;
+			rejectFunc = reject;
+		});
+
+		if (!callback) {
+			callback = function (err, friendList) {
+				if (err) {
+					return rejectFunc(err);
+				}
+				resolveFunc(friendList);
+			};
+		}
+
+		if (ctx.i_userID) {
+			throw { error: "Cannot set reaction as another profile." };
+		}
+
+		switch (reaction) {
+			case "\uD83D\uDE0D": //:heart_eyes:
+			case "\uD83D\uDE06": //:laughing:
+			case "\uD83D\uDE2E": //:open_mouth:
+			case "\uD83D\uDE22": //:cry:
+			case "\uD83D\uDE20": //:angry:
+			case "\uD83D\uDC4D": //:thumbsup:
+			case "\uD83D\uDC4E": //:thumbsdown:
+			case "\u2764": //:heart:
+			case "\uD83D\uDC97": //:glowingheart:
+			case "":
+				//valid
+				break;
+			case ":heart_eyes:":
+			case ":love:":
+				reaction = "\uD83D\uDE0D";
+				break;
+			case ":laughing:":
+			case ":haha:":
+				reaction = "\uD83D\uDE06";
+				break;
+			case ":open_mouth:":
+			case ":wow:":
+				reaction = "\uD83D\uDE2E";
+				break;
+			case ":cry:":
+			case ":sad:":
+				reaction = "\uD83D\uDE22";
+				break;
+			case ":angry:":
+				reaction = "\uD83D\uDE20";
+				break;
+			case ":thumbsup:":
+			case ":like:":
+				reaction = "\uD83D\uDC4D";
+				break;
+			case ":thumbsdown:":
+			case ":dislike:":
+				reaction = "\uD83D\uDC4E";
+				break;
+			case ":heart:":
+				reaction = "\u2764";
+				break;
+			case ":glowingheart:":
+				reaction = "\uD83D\uDC97";
+				break;
+			default:
+				if (forceCustomReaction) {
+					break;
+				}
+				return callback({ error: "Reaction is not a valid emoji." });
+		}
+
+		const variables = {
+			data: {
+				client_mutation_id: ctx.clientMutationId++,
+				actor_id: ctx.i_userID || ctx.userID,
+				action: reaction == "" ? "REMOVE_REACTION" : "ADD_REACTION",
+				message_id: messageID,
+				reaction: reaction
+			}
+		};
+
+		const qs = {
+			doc_id: "1491398900900362",
+			variables: JSON.stringify(variables),
+			dpr: 1
+		};
+
+		defaultFuncs
+			.postFormData(
+				"https://www.facebook.com/webgraphql/mutation/",
+				ctx.jar,
+				{},
+				qs
+			)
+			.then(utils.parseAndCheckLogin(ctx.jar, defaultFuncs))
+			.then(function (resData) {
+				if (!resData) {
+					throw { error: "setReaction returned empty object." };
+				}
+				if (resData.error || resData.errors) {
+					throw resData;
+				}
+				callback(null);
+			})
+			.catch(function (err) {
+				log.error("setReaction", err);
+				return callback(err);
+			});
+
+		return returnPromise;
+	};
+};