whalibmob 5.10.6 → 5.10.7

package/README.md

@@ -2149,7 +2149,7 @@ Both methods accept a **Buffer** (use `fs.readFileSync` to load a file).
 ```js
 const fs = require('fs')
 
-// change your own profile picture
+// change your own profile picture — any image, any shape, any size
 // returns the new picture id, or 'remove' when it was taken down
 const picId = await client.changeProfilePicture(fs.readFileSync('./avatar.jpg'))
 
@@ -2165,8 +2165,25 @@ const picId = await client.changeGroupPicture('120363000000000000@g.us',
 await client.changeGroupPicture('120363000000000000@g.us', null)
 ```
 
-`changeGroupPicture` throws when the server refuses — `406` for an image that is
-not a JPEG it will take, `403` when you are not an admin of that group.
+`changeGroupPicture` throws when the server refuses — `406` for an image it will
+not take, `403` when you are not an admin of that group.
+
+**Both calls re-encode the image before sending it.** WhatsApp wants a square
+640×640 JPEG, and a picture that is not one is *dropped without an answer*
+rather than refused — so an unprepared file fails as a timeout that looks like a
+network fault. The image is cropped square, scaled and written out as a fresh
+JPEG, which also strips EXIF and any progressive encoding the file was carrying.
+
+This needs `jimp` (an optional dependency) or `sharp`. Without either, the file
+is sent as it is and an already-correct picture still works.
+
+```js
+// skip the re-encode if you have prepared the image yourself
+await client.changeProfilePicture(buf, { raw: true })
+
+// or choose the size
+await client.changeProfilePicture(buf, { size: 640, quality: 50 })
+```
 
 ## Privacy
 

package/lib/Client.js

@@ -10,6 +10,7 @@ const { NoiseSocket }     = require('./noise');
 const { MessageSender, generateMessageId, makeJid, buildOrGetAdvIdentity } = require('./messages/MessageSender');
 const { checkIfRegistered, checkNumberStatus, requestSmsCode, verifyCode, assertRegistrationKeys, fetchIosVersion, fetchWaVersion } = require('./Registration');
 const { getDeviceConfig } = require('./DeviceConfig');
+const { prepareProfilePicture } = require('./MediaThumbnail');
 const { createNewStore, saveStore, loadStore, toSixParts, fromSixParts } = require('./Store');
 const { BinaryNode }      = require('./BinaryNode');
 const { AppStateStore, COLLECTIONS } = require('./appstate/AppStateStore');
@@ -4330,30 +4331,45 @@ class WhalibmobClient extends EventEmitter {
   // buf: Buffer with JPEG image data
   // Change your own profile picture.
   //
-  // buf: a Buffer of JPEG bytes, or null to remove the current picture.
+  // buf: a Buffer holding any image, or null to remove the current picture.
   // Returns the new picture id, or 'remove' when it was taken down.
   //
+  // The image is re-encoded to the square 640x640 JPEG the server expects
+  // before it goes out. Sending a file as it came off disk is what a person
+  // naturally tries and what the server silently drops — pass { raw: true } to
+  // skip that if you have already prepared it yourself.
+  //
   // The picture is not addressed by sending the IQ *to* yourself: it goes to
   // the server with the account named in `target`, the same shape a group
   // picture uses. Addressed the other way the server files it nowhere and never
   // answers, which looked from the outside like the picture had been set — the
   // stanza went out, nothing came back, and nothing checked.
-  async changeProfilePicture(buf) {
+  async changeProfilePicture(buf, opts) {
     if (!this._store) throw new Error('Not connected');
+    opts = opts || {};
     const selfJid = this._ownDeviceJid
       ? toNonAdJid(this._ownDeviceJid())
       : `${this._store.phoneNumber}@s.whatsapp.net`;
 
+    const picture = (buf && !opts.raw) ? await prepareProfilePicture(buf, opts) : buf;
+
     const node = new BinaryNode('iq', {
       id:     this._genMsgId(),
       xmlns:  'w:profile:picture',
       to:     's.whatsapp.net',
       target: jidStrToObj(selfJid),
       type:   'set'
-    }, buf ? [new BinaryNode('picture', { type: 'image' }, buf)] : null);
+    }, picture ? [new BinaryNode('picture', { type: 'image' }, picture)] : null);
 
     const resp = await this._sendIq(node);
-    if (!resp) throw new Error('changeProfilePicture: no reply from server (IQ timed out)');
+    if (!resp) {
+      throw new Error('changeProfilePicture: no reply from server (IQ timed out). ' +
+        'The server drops a picture it will not take rather than refusing it, so ' +
+        'this usually means the image was not in the form it wants' +
+        (opts.raw ? ' — this call passed { raw: true }, so nothing was re-encoded'
+                  : '. Install jimp if it is not present, so the image can be ' +
+                    're-encoded before sending') + '.');
+    }
     if (resp.attrs && resp.attrs.type === 'error') {
       const errNode = findChild(resp, 'error');
       const code    = errNode && errNode.attrs && errNode.attrs.code;
@@ -5923,7 +5939,12 @@ class WhalibmobClient extends EventEmitter {
   //
   // Removal is the IQ with no body at all — an empty <picture> node is a
   // malformed upload rather than a delete, and the server answers 406 for it.
-  async changeGroupPicture(groupJid, buf) {
+  //
+  // The image is re-encoded to a square 640x640 JPEG first, on the same terms
+  // as a profile picture; { raw: true } skips that.
+  async changeGroupPicture(groupJid, buf, opts) {
+    opts = opts || {};
+    const picture = (buf && !opts.raw) ? await prepareProfilePicture(buf, opts) : buf;
     const id = this._genMsgId();
     const node = new BinaryNode('iq', {
       id,
@@ -5931,9 +5952,13 @@ class WhalibmobClient extends EventEmitter {
       target: jidStrToObj(makeJid(groupJid)),
       to:     's.whatsapp.net',
       type:   'set'
-    }, buf ? [new BinaryNode('picture', { type: 'image' }, buf)] : null);
+    }, picture ? [new BinaryNode('picture', { type: 'image' }, picture)] : null);
     const resp = await this._sendIq(node);
-    if (!resp) throw new Error('changeGroupPicture: no reply from server (IQ timed out)');
+    if (!resp) {
+      throw new Error('changeGroupPicture: no reply from server (IQ timed out). ' +
+        'The server drops a picture it will not take rather than refusing it, so ' +
+        'this usually means the image was not in the form it wants.');
+    }
     if (resp.attrs && resp.attrs.type === 'error') {
       const errNode = findChild(resp, 'error');
       const code    = errNode && errNode.attrs && errNode.attrs.code;

package/lib/MediaThumbnail.js

@@ -290,6 +290,70 @@ async function imageThumbnail(buf, opts) {
   return out;
 }
 
+// ─── Profile pictures ────────────────────────────────────────────────────────
+
+// What WhatsApp's own apps upload. The server will not take an arbitrary file:
+// it wants a square JPEG at this size, and a picture that is not one is dropped
+// without an answer rather than refused, so the failure gives no clue.
+const AVATAR_SIZE    = 640;
+const AVATAR_QUALITY = 50;
+
+/**
+ * Re-encode an image into the form a profile picture has to be in.
+ *
+ * Cropped square from the top-left of the shorter side, scaled to 640x640, and
+ * written out as a fresh JPEG. Re-encoding is the point rather than a side
+ * effect: it strips EXIF, progressive scans and unusual chroma subsampling —
+ * anything the file happened to carry — and produces a plain baseline JPEG.
+ *
+ * Returns the original buffer untouched when no image library is installed,
+ * which at least gives an already-correct picture a chance to go through.
+ */
+async function prepareProfilePicture(buf, opts) {
+  opts = opts || {};
+  if (!Buffer.isBuffer(buf) || !buf.length) return buf;
+
+  const size    = opts.size    || AVATAR_SIZE;
+  const quality = opts.quality || AVATAR_QUALITY;
+
+  try {
+    const lib = await loadImageLib();
+
+    if (lib && lib.kind === 'sharp') {
+      return await lib.sharp(buf)
+        .resize(size, size, { fit: 'cover' })
+        .jpeg({ quality })
+        .toBuffer();
+    }
+
+    if (lib && lib.kind === 'jimp1') {
+      const img = await lib.Jimp.read(buf);
+      const min = Math.min(img.width, img.height);
+      const sq  = img.crop({ x: 0, y: 0, w: min, h: min });
+      const resizeOpts = { w: size, h: size };
+      if (lib.ResizeStrategy && lib.ResizeStrategy.BILINEAR) {
+        resizeOpts.mode = lib.ResizeStrategy.BILINEAR;
+      }
+      return await sq.resize(resizeOpts).getBuffer('image/jpeg', { quality });
+    }
+
+    if (lib && lib.kind === 'jimp0') {
+      const Jimp = lib.Jimp;
+      const img  = await Jimp.read(buf);
+      const min  = Math.min(img.bitmap.width, img.bitmap.height);
+      img.crop(0, 0, min, min).resize(size, size).quality(quality);
+      return await img.getBufferAsync(Jimp.MIME_JPEG);
+    }
+  } catch (err) {
+    _whaDbg('[DBG] AVATAR could not re-encode: ' + (err && err.message));
+    return buf;
+  }
+
+  _whaDbg('[DBG] AVATAR no image library — sending the file as it is. ' +
+    'WhatsApp wants a square JPEG; install jimp to have that done for you.');
+  return buf;
+}
+
 // ─── ffmpeg ──────────────────────────────────────────────────────────────────
 
 function run(cmd, args) {
@@ -385,8 +449,11 @@ module.exports = {
   probeImageSize,
   extractExifThumbnail,
   imageThumbnail,
+  prepareProfilePicture,
   videoThumbnail,
   hasFfmpeg,
   THUMB_WIDTH,
-  THUMB_QUALITY
+  THUMB_QUALITY,
+  AVATAR_SIZE,
+  AVATAR_QUALITY
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whalibmob",
-  "version": "5.10.6",
+  "version": "5.10.7",
   "description": "WhatsApp library for interaction with WhatsApp Mobile API no web",
   "author": "Kunboruto20",
   "main": "index.js",