@cexy/hoonfca 1.0.0 → 1.0.2

package/src/getThreadHistory.js

@@ -1,17 +1,8 @@
 "use strict";
 
-const utils = require("../utils");
+var utils = require("../utils");
+var log = require("npmlog");
 
-// ফাইলের এক্সটেনশন বের করার হেল্পার ফাংশন
-function getExtension(original_extension, filename = "") {
-  if (original_extension) {
-    return original_extension;
-  }
-  const extension = filename.split(".").pop();
-  return extension === filename ? "" : extension;
-}
-
-// গ্রাফকিউএল রেসপন্স থেকে বিভিন্ন মিডিয়া অ্যাটাচমেন্ট ফরম্যাট করার ফাংশন
 function formatAttachmentsGraphQLResponse(attachment) {
   switch (attachment.__typename) {
     case "MessageImage":
@@ -19,21 +10,23 @@ function formatAttachmentsGraphQLResponse(attachment) {
         type: "photo",
         ID: attachment.legacy_attachment_id,
         filename: attachment.filename,
-        original_extension: getExtension(
-          attachment.original_extension,
-          attachment.filename
-        ),
         thumbnailUrl: attachment.thumbnail.uri,
+
         previewUrl: attachment.preview.uri,
         previewWidth: attachment.preview.width,
         previewHeight: attachment.preview.height,
+
         largePreviewUrl: attachment.large_preview.uri,
         largePreviewHeight: attachment.large_preview.height,
         largePreviewWidth: attachment.large_preview.width,
-        url: attachment.large_preview.uri,
-        width: attachment.large_preview.width,
-        height: attachment.large_preview.height,
-        name: attachment.filename,
+
+        // You have to query for the real image. See below.
+        url: attachment.large_preview.uri, // @Legacy
+        width: attachment.large_preview.width, // @Legacy
+        height: attachment.large_preview.height, // @Legacy
+        name: attachment.filename, // @Legacy
+
+        // @Undocumented
         attributionApp: attachment.attribution_app
           ? {
               attributionAppID: attachment.attribution_app.id,
@@ -41,30 +34,48 @@ function formatAttachmentsGraphQLResponse(attachment) {
               logo: attachment.attribution_app.square_logo,
             }
           : null,
+
+        // @TODO No idea what this is, should we expose it?
+        //      Ben - July 15th 2017
+        // renderAsSticker: attachment.render_as_sticker,
+
+        // This is _not_ the real URI, this is still just a large preview.
+        // To get the URL we'll need to support a POST query to
+        //
+        //    https://www.facebook.com/webgraphql/query/
+        //
+        // With the following query params:
+        //
+        //    query_id:728987990612546
+        //    variables:{"id":"100009069356507","photoID":"10213724771692996"}
+        //    dpr:1
+        //
+        // No special form though.
       };
     case "MessageAnimatedImage":
       return {
         type: "animated_image",
         ID: attachment.legacy_attachment_id,
         filename: attachment.filename,
-        original_extension: getExtension(
-          attachment.original_extension,
-          attachment.filename
-        ),
+
         previewUrl: attachment.preview_image.uri,
         previewWidth: attachment.preview_image.width,
         previewHeight: attachment.preview_image.height,
+
         url: attachment.animated_image.uri,
         width: attachment.animated_image.width,
         height: attachment.animated_image.height,
-        thumbnailUrl: attachment.preview_image.uri,
-        name: attachment.filename,
-        facebookUrl: attachment.animated_image.uri,
-        rawGifImage: attachment.animated_image.uri,
-        animatedGifUrl: attachment.animated_image.uri,
-        animatedGifPreviewUrl: attachment.preview_image.uri,
-        animatedWebpUrl: attachment.animated_image.uri,
-        animatedWebpPreviewUrl: attachment.preview_image.uri,
+
+        thumbnailUrl: attachment.preview_image.uri, // @Legacy
+        name: attachment.filename, // @Legacy
+        facebookUrl: attachment.animated_image.uri, // @Legacy
+        rawGifImage: attachment.animated_image.uri, // @Legacy
+        animatedGifUrl: attachment.animated_image.uri, // @Legacy
+        animatedGifPreviewUrl: attachment.preview_image.uri, // @Legacy
+        animatedWebpUrl: attachment.animated_image.uri, // @Legacy
+        animatedWebpPreviewUrl: attachment.preview_image.uri, // @Legacy
+
+        // @Undocumented
         attributionApp: attachment.attribution_app
           ? {
               attributionAppID: attachment.attribution_app.id,
@@ -76,107 +87,185 @@ function formatAttachmentsGraphQLResponse(attachment) {
     case "MessageVideo":
       return {
         type: "video",
-        ID: attachment.legacy_attachment_id,
         filename: attachment.filename,
-        original_extension: getExtension(
-          attachment.original_extension,
-          attachment.filename
-        ),
-        duration: attachment.playable_duration_in_ms,
-        thumbnailUrl: attachment.large_image.uri,
+        ID: attachment.legacy_attachment_id,
+
+        thumbnailUrl: attachment.large_image.uri, // @Legacy
+
         previewUrl: attachment.large_image.uri,
         previewWidth: attachment.large_image.width,
         previewHeight: attachment.large_image.height,
+
         url: attachment.playable_url,
         width: attachment.original_dimensions.x,
         height: attachment.original_dimensions.y,
-        videoType: attachment.video_type?.toLowerCase(),
+
+        duration: attachment.playable_duration_in_ms,
+        videoType: attachment.video_type.toLowerCase(),
       };
     case "MessageFile":
       return {
         type: "file",
-        ID: attachment.message_file_fbid,
         filename: attachment.filename,
-        original_extension: getExtension(
-          attachment.original_extension,
-          attachment.filename
-        ),
+        ID: attachment.message_file_fbid,
+
         url: attachment.url,
         isMalicious: attachment.is_malicious,
         contentType: attachment.content_type,
-        name: attachment.filename,
-        mimeType: "",
-        fileSize: -1,
+
+        name: attachment.filename, // @Legacy
+        mimeType: "", // @Legacy
+        fileSize: -1, // @Legacy
       };
     case "MessageAudio":
       return {
         type: "audio",
-        ID: attachment.url_shimhash,
         filename: attachment.filename,
-        original_extension: getExtension(
-          attachment.original_extension,
-          attachment.filename
-        ),
-        duration: attachment.playable_duration_in_ms,
+        ID: attachment.url_shimhash, // Not fowardable
+
         audioType: attachment.audio_type,
+        duration: attachment.playable_duration_in_ms,
         url: attachment.playable_url,
+
         isVoiceMail: attachment.is_voicemail,
       };
     default:
       return {
-        error: `Don't know about attachment type ${attachment.__typename}`,
+        error: "Don't know about attachment type " + attachment.__typename,
       };
   }
 }
 
-// এক্সটেনসিবল শেয়ার কন্টেন্ট ফরম্যাট করার ফাংশন
 function formatExtensibleAttachment(attachment) {
   if (attachment.story_attachment) {
-    const { story_attachment } = attachment;
-    const media = story_attachment.media;
-    const hasMedia = media != null && (media.animated_image != null || media.image != null);
-    const mediaUri = hasMedia ? (media.animated_image || media.image).uri : null;
-    const mediaWidth = hasMedia ? (media.animated_image || media.image).width : null;
-    const mediaHeight = hasMedia ? (media.animated_image || media.image).height : null;
-
     return {
       type: "share",
       ID: attachment.legacy_attachment_id,
-      url: story_attachment.url,
-      title: story_attachment.title_with_entities?.text,
-      description: story_attachment.description?.text,
-      source: story_attachment.source?.text,
-      image: mediaUri,
-      width: mediaWidth,
-      height: mediaHeight,
-      playable: media?.is_playable,
-      duration: media?.playable_duration_in_ms,
-      playableUrl: media?.playable_url,
-      subattachments: story_attachment.subattachments,
-      properties: (story_attachment.properties || []).reduce((obj, cur) => {
-        obj[cur.key] = cur.value?.text;
+      url: attachment.story_attachment.url,
+
+      title: attachment.story_attachment.title_with_entities.text,
+      description:
+        attachment.story_attachment.description &&
+        attachment.story_attachment.description.text,
+      source:
+        attachment.story_attachment.source == null
+          ? null
+          : attachment.story_attachment.source.text,
+
+      image:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.animated_image == null &&
+              attachment.story_attachment.media.image == null
+            ? null
+            : (
+                attachment.story_attachment.media.animated_image ||
+                attachment.story_attachment.media.image
+              ).uri,
+      width:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.animated_image == null &&
+              attachment.story_attachment.media.image == null
+            ? null
+            : (
+                attachment.story_attachment.media.animated_image ||
+                attachment.story_attachment.media.image
+              ).width,
+      height:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.animated_image == null &&
+              attachment.story_attachment.media.image == null
+            ? null
+            : (
+                attachment.story_attachment.media.animated_image ||
+                attachment.story_attachment.media.image
+              ).height,
+      playable:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.is_playable,
+      duration:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.playable_duration_in_ms,
+      playableUrl:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.playable_url,
+
+      subattachments: attachment.story_attachment.subattachments,
+
+      // Format example:
+      //
+      //   [{
+      //     key: "width",
+      //     value: { text: "1280" }
+      //   }]
+      //
+      // That we turn into:
+      //
+      //   {
+      //     width: "1280"
+      //   }
+      //
+      properties: attachment.story_attachment.properties.reduce(function (
+        obj,
+        cur,
+      ) {
+        obj[cur.key] = cur.value.text;
         return obj;
       }, {}),
-      animatedImageSize: "",
-      facebookUrl: "",
-      styleList: "",
-      target: "",
-      thumbnailUrl: mediaUri,
-      thumbnailWidth: mediaWidth,
-      thumbnailHeight: mediaHeight,
+
+      // Deprecated fields
+      animatedImageSize: "", // @Legacy
+      facebookUrl: "", // @Legacy
+      styleList: "", // @Legacy
+      target: "", // @Legacy
+      thumbnailUrl:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.animated_image == null &&
+              attachment.story_attachment.media.image == null
+            ? null
+            : (
+                attachment.story_attachment.media.animated_image ||
+                attachment.story_attachment.media.image
+              ).uri, // @Legacy
+      thumbnailWidth:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.animated_image == null &&
+              attachment.story_attachment.media.image == null
+            ? null
+            : (
+                attachment.story_attachment.media.animated_image ||
+                attachment.story_attachment.media.image
+              ).width, // @Legacy
+      thumbnailHeight:
+        attachment.story_attachment.media == null
+          ? null
+          : attachment.story_attachment.media.animated_image == null &&
+              attachment.story_attachment.media.image == null
+            ? null
+            : (
+                attachment.story_attachment.media.animated_image ||
+                attachment.story_attachment.media.image
+              ).height, // @Legacy
     };
+  } else {
+    return { error: "Don't know what to do with extensible_attachment." };
   }
-  return { error: "Don't know what to do with extensible_attachment." };
 }
 
 function formatReactionsGraphQL(reaction) {
   return {
     reaction: reaction.reaction,
-    userID: reaction.user?.id,
+    userID: reaction.user.id,
   };
 }
 
-// অ্যাডমিন ইভেন্ট ডাটা ম্যাপিং
 function formatEventData(event) {
   if (event == null) {
     return {};
@@ -184,24 +273,30 @@ function formatEventData(event) {
 
   switch (event.__typename) {
     case "ThemeColorExtensibleMessageAdminText":
-      return { color: event.theme_color };
+      return {
+        color: event.theme_color,
+      };
     case "ThreadNicknameExtensibleMessageAdminText":
       return {
         nickname: event.nickname,
         participantID: event.participant_id,
       };
     case "ThreadIconExtensibleMessageAdminText":
-      return { threadIcon: event.thread_icon };
+      return {
+        threadIcon: event.thread_icon,
+      };
     case "InstantGameUpdateExtensibleMessageAdminText":
       return {
-        gameID: event.game?.id,
+        gameID: event.game == null ? null : event.game.id,
         update_type: event.update_type,
         collapsed_text: event.collapsed_text,
         expanded_text: event.expanded_text,
         instant_game_update_data: event.instant_game_update_data,
       };
     case "GameScoreExtensibleMessageAdminText":
-      return { game_type: event.game_type };
+      return {
+        game_type: event.game_type,
+      };
     case "RtcCallLogExtensibleMessageAdminText":
       return {
         event: event.event,
@@ -236,6 +331,7 @@ function formatEventData(event) {
         ad_preferences_link: event.ad_preferences_link,
         ad_properties: event.ad_properties,
       };
+    // never data
     case "ParticipantJoinedGroupCallExtensibleMessageAdminText":
     case "ThreadEphemeralTtlModeExtensibleMessageAdminText":
     case "StartedSharingVideoExtensibleMessageAdminText":
@@ -249,50 +345,58 @@ function formatEventData(event) {
       return {};
     default:
       return {
-        error: `Don't know what to with event data type ${event.__typename}`,
+        error: "Don't know what to with event data type " + event.__typename,
       };
   }
 }
 
-// সম্পূর্ণ চ্যাট হিস্ট্রি পার্স করার মেইন হেল্পার
 function formatMessagesGraphQLResponse(data) {
-  const messageThread = data.o0.data.message_thread;
-  const threadID = messageThread.thread_key.thread_fbid
+  var messageThread = data.o0.data.message_thread;
+  var threadID = messageThread.thread_key.thread_fbid
     ? messageThread.thread_key.thread_fbid
     : messageThread.thread_key.other_user_id;
 
-  return messageThread.messages.nodes.map(d => {
+  var messages = messageThread.messages.nodes.map(function (d) {
     switch (d.__typename) {
       case "UserMessage":
-        let maybeStickerAttachment = null;
+        // Give priority to stickers. They're seen as normal messages but we've
+        // been considering them as attachments.
+        var maybeStickerAttachment;
         if (d.sticker) {
           maybeStickerAttachment = [
             {
               type: "sticker",
               ID: d.sticker.id,
               url: d.sticker.url,
-              packID: d.sticker.pack?.id,
+
+              packID: d.sticker.pack.id,
               spriteUrl: d.sticker.sprite_image,
               spriteUrl2x: d.sticker.sprite_image_2x,
               width: d.sticker.width,
               height: d.sticker.height,
-              caption: d.snippet,
-              description: d.sticker.label,
+
+              caption: d.snippet, // Not sure what the heck caption was.
+              description: d.sticker.label, // Not sure about this one either.
+
               frameCount: d.sticker.frame_count,
               frameRate: d.sticker.frame_rate,
               framesPerRow: d.sticker.frames_per_row,
               framesPerCol: d.sticker.frames_per_col,
-              stickerID: d.sticker.id,
-              spriteURI: d.sticker.sprite_image,
-              spriteURI2x: d.sticker.sprite_image_2x,
+
+              stickerID: d.sticker.id, // @Legacy
+              spriteURI: d.sticker.sprite_image, // @Legacy
+              spriteURI2x: d.sticker.sprite_image_2x, // @Legacy
             },
           ];
         }
 
-        const mentionsObj = {};
+        var mentionsObj = {};
         if (d.message !== null) {
-          d.message.ranges.forEach(e => {
-            mentionsObj[e.entity.id] = d.message.text.substr(e.offset, e.length);
+          d.message.ranges.forEach((e) => {
+            mentionsObj[e.entity.id] = d.message.text.substr(
+              e.offset,
+              e.length,
+            );
           });
         }
 
@@ -311,8 +415,11 @@ function formatMessagesGraphQLResponse(data) {
           senderID: d.message_sender.id,
           threadID: threadID,
           timestamp: d.timestamp_precise,
+
           mentions: mentionsObj,
           isUnread: d.unread,
+
+          // New
           messageReactions: d.message_reactions
             ? d.message_reactions.map(formatReactionsGraphQL)
             : null,
@@ -329,7 +436,11 @@ function formatMessagesGraphQLResponse(data) {
           timestamp: d.timestamp_precise,
           eventType: "change_thread_name",
           snippet: d.snippet,
-          eventData: { threadName: d.thread_name },
+          eventData: {
+            threadName: d.thread_name,
+          },
+
+          // @Legacy
           author: d.message_sender.id,
           logMessageType: "log:thread-name",
           logMessageData: { name: d.thread_name },
@@ -346,8 +457,9 @@ function formatMessagesGraphQLResponse(data) {
           snippet: d.snippet,
           eventData:
             d.image_with_metadata == null
-              ? {}
+              ? {} /* removed image */
               : {
+                  /* image added */
                   threadImage: {
                     attachmentID: d.image_with_metadata.legacy_attachment_id,
                     width: d.image_with_metadata.original_dimensions.x,
@@ -355,9 +467,13 @@ function formatMessagesGraphQLResponse(data) {
                     url: d.image_with_metadata.preview.uri,
                   },
                 },
+
+          // @Legacy
           logMessageType: "log:thread-icon",
           logMessageData: {
-            thread_icon: d.image_with_metadata ? d.image_with_metadata.preview.uri : null,
+            thread_icon: d.image_with_metadata
+              ? d.image_with_metadata.preview.uri
+              : null,
           },
         };
       case "ParticipantLeftMessage":
@@ -371,11 +487,18 @@ function formatMessagesGraphQLResponse(data) {
           eventType: "remove_participants",
           snippet: d.snippet,
           eventData: {
-            participantsRemoved: d.participants_removed.map(p => p.id),
+            // Array of IDs.
+            participantsRemoved: d.participants_removed.map(function (p) {
+              return p.id;
+            }),
           },
+
+          // @Legacy
           logMessageType: "log:unsubscribe",
           logMessageData: {
-            leftParticipantFbId: d.participants_removed.map(p => p.id),
+            leftParticipantFbId: d.participants_removed.map(function (p) {
+              return p.id;
+            }),
           },
         };
       case "ParticipantsAddedMessage":
@@ -389,11 +512,18 @@ function formatMessagesGraphQLResponse(data) {
           eventType: "add_participants",
           snippet: d.snippet,
           eventData: {
-            participantsAdded: d.participants_added.map(p => p.id),
+            // Array of IDs.
+            participantsAdded: d.participants_added.map(function (p) {
+              return p.id;
+            }),
           },
+
+          // @Legacy
           logMessageType: "log:subscribe",
           logMessageData: {
-            addedParticipants: d.participants_added.map(p => p.id),
+            addedParticipants: d.participants_added.map(function (p) {
+              return p.id;
+            }),
           },
         };
       case "VideoCallMessage":
@@ -406,6 +536,8 @@ function formatMessagesGraphQLResponse(data) {
           timestamp: d.timestamp_precise,
           eventType: "video_call",
           snippet: d.snippet,
+
+          // @Legacy
           logMessageType: "other",
         };
       case "VoiceCallMessage":
@@ -418,6 +550,8 @@ function formatMessagesGraphQLResponse(data) {
           timestamp: d.timestamp_precise,
           eventType: "voice_call",
           snippet: d.snippet,
+
+          // @Legacy
           logMessageType: "other",
         };
       case "GenericAdminTextMessage":
@@ -431,37 +565,50 @@ function formatMessagesGraphQLResponse(data) {
           snippet: d.snippet,
           eventType: d.extensible_message_admin_text_type.toLowerCase(),
           eventData: formatEventData(d.extensible_message_admin_text),
+
+          // @Legacy
           logMessageType: utils.getAdminTextMessageType(
-            d.extensible_message_admin_text_type
+            d.extensible_message_admin_text_type,
           ),
-          logMessageData: d.extensible_message_admin_text,
+          logMessageData: d.extensible_message_admin_text, // Maybe different?
         };
       default:
-        return { error: `Don't know about message type ${d.__typename}` };
+        return { error: "Don't know about message type " + d.__typename };
     }
   });
+  return messages;
 }
 
 module.exports = function (defaultFuncs, api, ctx) {
-  return function getThreadHistoryGraphQL(threadID, amount, timestamp, callback) {
-    let resolveFunc = () => {};
-    let rejectFunc = () => {};
-    const returnPromise = new Promise((resolve, reject) => {
+  return function getThreadHistoryGraphQL(
+    threadID,
+    amount,
+    timestamp,
+    callback,
+  ) {
+    var resolveFunc = function () {};
+    var rejectFunc = function () {};
+    var returnPromise = new Promise(function (resolve, reject) {
       resolveFunc = resolve;
       rejectFunc = reject;
     });
 
     if (!callback) {
-      callback = (err, data) => {
-        if (err) return rejectFunc(err);
+      callback = function (err, data) {
+        if (err) {
+          return rejectFunc(err);
+        }
         resolveFunc(data);
       };
     }
 
-    const form = {
+    // `queries` has to be a string. I couldn't tell from the dev console. This
+    // took me a really long time to figure out. I deserve a cookie for this.
+    var form = {
       av: ctx.globalOptions.pageID,
       queries: JSON.stringify({
         o0: {
+          // This doc_id was valid on February 2nd 2017.
           doc_id: "1498317363570230",
           query_params: {
             id: threadID,
@@ -477,17 +624,21 @@ module.exports = function (defaultFuncs, api, ctx) {
     defaultFuncs
       .post("https://www.facebook.com/api/graphqlbatch/", ctx.jar, form)
       .then(utils.parseAndCheckLogin(ctx, defaultFuncs))
-      .then(resData => {
+      .then(function (resData) {
         if (resData.error) {
           throw resData;
         }
+        // This returns us an array of things. The last one is the success /
+        // failure one.
+        // @TODO What do we do in this case?
         if (resData[resData.length - 1].error_results !== 0) {
-          throw new Error("There was an error_result in GraphQLBatch.");
+          throw new Error("There was an error_result.");
         }
-        return callback(null, formatMessagesGraphQLResponse(resData[0]));
+
+        callback(null, formatMessagesGraphQLResponse(resData[0]));
       })
-      .catch(err => {
-        utils.error("getThreadHistoryGraphQL", err);
+      .catch(function (err) {
+        log.error("getThreadHistoryGraphQL", err);
         return callback(err);
       });