Create python-publish.yml

Not tested yet

.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

CNAME

@@ -0,0 +1 @@
+wts.knugi.com

README.md

@@ -1,45 +1,130 @@
 # Whatsapp-Chat-Exporter
-A Whatsapp database parser that will give you the history of your Whatsapp conversation in HTML and JSON
+[![Latest in Pypi](https://img.shields.io/pypi/v/whatsapp-chat-exporter?label=Latest%20in%20Pypi)](https://pypi.org/project/whatsapp-chat-exporter/)
+![License MIT](https://img.shields.io/pypi/l/whatsapp-chat-exporter)
+[![Python](https://img.shields.io/pypi/pyversions/Whatsapp-Chat-Exporter)](https://pypi.org/project/Whatsapp-Chat-Exporter/)
+
+A customizable Android and iPhone Whatsapp database parser that will give you the history of your Whatsapp conversations in HTML and JSON.  
+**If you plan to uninstall WhatsApp or delete your WhatsApp account, please make a backup of your WhatsApp database. You may want to use this exporter again on the same database in the future as the exporter develops**
 
 # Usage
-First, clone this repo, and copy all py and html files to a working directory if you want to do so.
+**If you want to use the old release (< 0.5) of the exporter, please follow the [old usage guide](https://github.com/KnugiHK/Whatsapp-Chat-Exporter/blob/main/old_README.md#usage)**
+
+First, install the exporter by:
 ```shell
-git clone https://github.com/KnugiHK/Whatsapp-Chat-Exporter.git
+pip install whatsapp-chat-exporter
+pip install whatsapp-chat-exporter[android_backup]  & :: Optional, if you want it to support decrypting Android WhatsApp backup.
 ```
-Then, ready your WhatsApp database, place them in the root of working directory.
-* For Android, it is called msgstore.db. If you want name of your contacts, get the contact database, which is called wa.db.
-* For iPhone, it is called 7c7fba66680ef796b916b067077cc246adacf01d (YES, a hash).
+Then, create a working directory in somewhere you want
+```shell
+mkdir working_wts
+cd working_wts
+```
+## Working with Android
+### Unencrypted WhatsApp database
+Extract the WhatsApp database with whatever means, one possible means is to use the [WhatsApp-Key-DB-Extractor](https://github.com/KnugiHK/WhatsApp-Key-DB-Extractor)
 
-Next, ready your media folder, place it in the root of working directory.
-* For Android, copy the WhatsApp directory from your phone directly.
-* For iPhone, run the extract_iphone_media.py, and you will get a folder called Message. Please note that, this script does not support encrypted backup.
-```
-python extract_iphone_media.py "C:\Users\[Username]\AppData\Roaming\Apple Computer\MobileSync\Backup\[device id]"
-```
-And now, you should have something like this:
+After you obtain your WhatsApp database, copy the WhatsApp database and media folder to the working directory. The database is called msgstore.db. If you also want the name of your contacts, get the contact database, which is called wa.db. And copy the WhatsApp (Media) directory from your phone directly.
 
-![Folder structure](structure.png)
+And now, you should have something like this in the working directory.
 
-Last, run the script regarding the type of phone.
+![Android folder structure](imgs/android_structure.png)
+#### Extracting
+Simply invoke the following command from shell.
+```sh
+wtsexporter -a
 ```
-python extract.py & :: Android
-python extract_iphone.py & :: iPhone
+
+### Encrypted Android WhatsApp Backup
+In order to support the decryption, install pycryptodome if it is not installed
+```sh
+pip install pycryptodome # Or 
+pip install whatsapp-chat-exporter["android_backup"] # install along with this software
 ```
-And you will get these:
+#### Crypt12 or Crypt14
+Place the decryption key file (key) and the encrypted WhatsApp Backup (msgstore.db.crypt14) in the working directory. If you also want the name of your contacts, get the contact database, which is called wa.db. And copy the WhatsApp (Media) directory from your phone directly.
+
+And now, you should have something like this in the working directory.
+
+![Android folder structure with WhatsApp Backup](imgs/android_structure_backup.png)
+#### Extracting
+Simply invoke the following command from shell.
+```sh
+wtsexporter -a -k key -b msgstore.db.crypt14
+```
+
+#### Crypt15 (End-to-End Encrypted Backup)
+To support Crypt15 backup, install javaobj-py3 if it is not installed
+```sh
+pip install javaobj-py3 # Or 
+pip install whatsapp-chat-exporter["crypt15"] # install along with this software
+```
+Place the encrypted WhatsApp Backup (msgstore.db.crypt15) in the working directory. If you also want the name of your contacts, get the contact database, which is called wa.db. And copy the WhatsApp (Media) directory from your phone directly.  
+If you do not have the 32 bytes hex key (64 hexdigits), place the decryption key file (encrypted_backup.key) extracted from Android. If you gave the 32 bytes hex key, simply put the key in the shell.
+
+Now, you should have something like this in the working directory (if you do not have 32 bytes hex key).
+
+![Android folder structure with WhatsApp Crypt15 Backup](imgs/android_structure_backup_crypt15.png)
+##### Extracting
+If you do not have 32 bytes hex key but have the key file available, simply invoke the following command from shell.
+```sh
+wtsexporter -a -k encrypted_backup.key -b msgstore.db.crypt15
+```
+If you have the 32 bytes hex key, simply put the hex key in the -k option and invoke the command from shell like this:
+```sh
+wtsexporter -a -k 432435053b5204b08e5c3823423399aa30ff061435ab89bc4e6713969cdaa5a8 -b msgstore.db.crypt15
+```
+
+## Working with iPhone
+Do an iPhone Backup with iTunes first.
+### Encrypted iPhone Backup
+**If you are working on unencrypted iPhone backup, skip this**
+
+If you want to work on an encrypted iPhone Backup, you should install iphone_backup_decrypt from [KnugiHK/iphone_backup_decrypt](https://github.com/KnugiHK/iphone_backup_decrypt) before you run the extract_iphone_media.py.
+```sh
+pip install git+https://github.com/KnugiHK/iphone_backup_decrypt
+```
+### Extracting
+Simply invoke the following command from shell, remember to replace the username and device id correspondingly in the command.
+```sh
+wtsexporter -i -b "C:\Users\[Username]\AppData\Roaming\Apple Computer\MobileSync\Backup\[device id]"
+```
+
+## Results
+After extracting, you will get these:
 #### Private Message
-![Private Message](pm.png)
+![Private Message](imgs/pm.png)
 
 #### Group Message
-![Group Message](group.png)
+![Group Message](imgs/group.png)
 
-# Encrypted iPhone Backup
-To do
+## More options
+Invoke the wtsexporter with --help option will show you all options available.
+```sh
+> wtsexporter --help
+Usage: wtsexporter [options]
+
+Options:
+  --version             show program's version number and exit
+  -h, --help            show this help message and exit
+  -a, --android         Define the target as Android
+  -i, --iphone          Define the target as iPhone
+  -w WA, --wa=WA        Path to contact database
+  -m MEDIA, --media=MEDIA
+                        Path to WhatsApp media folder
+  -b BACKUP, --backup=BACKUP
+                        Path to Android (must be used together with -k)/iPhone
+                        WhatsApp backup
+  -o OUTPUT, --output=OUTPUT
+                        Output to specific directory
+  -j, --json            Save the result to a single JSON file
+  -d DB, --db=DB        Path to database file
+  -k KEY, --key=KEY     Path to key file
+  -t TEMPLATE, --template=TEMPLATE
+                        Path to custom HTML template
+```
 
 # To do
-1. Convert ```\r\n``` to ```<br>```
-2. Reply in iPhone
-3. The CSS for metadata (e.g. {Message Deleted})
-4. Handle encrypted iPhone Backup
+1. Reply in iPhone
 
 # Copyright
 This is a MIT licensed project.

Whatsapp_Chat_Exporter/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.8.0"

Whatsapp_Chat_Exporter/__main__.py

@@ -0,0 +1,195 @@
+from .__init__ import __version__
+from Whatsapp_Chat_Exporter import extract, extract_iphone
+from Whatsapp_Chat_Exporter import extract_iphone_media
+from Whatsapp_Chat_Exporter.extract import Crypt
+from optparse import OptionParser
+import os
+import sqlite3
+import shutil
+import json
+import string
+from sys import exit
+
+
+def main():
+    parser = OptionParser(version=f"Whatsapp Chat Exporter: {__version__}")
+    parser.add_option(
+        '-a',
+        '--android',
+        dest='android',
+        default=False,
+        action='store_true',
+        help="Define the target as Android")
+    parser.add_option(
+        '-i',
+        '--iphone',
+        dest='iphone',
+        default=False,
+        action='store_true',
+        help="Define the target as iPhone")
+    parser.add_option(
+        "-w",
+        "--wa",
+        dest="wa",
+        default=None,
+        help="Path to contact database")
+    parser.add_option(
+        "-m",
+        "--media",
+        dest="media",
+        default=None,
+        help="Path to WhatsApp media folder")
+    parser.add_option(
+        "-b",
+        "--backup",
+        dest="backup",
+        default=None,
+        help="Path to Android (must be used together "
+             "with -k)/iPhone WhatsApp backup")
+    parser.add_option(
+        "-o",
+        "--output",
+        dest="output",
+        default="result",
+        help="Output to specific directory")
+    parser.add_option(
+        '-j',
+        '--json',
+        dest='json',
+        default=False,
+        action='store_true',
+        help="Save the result to a single JSON file")
+    parser.add_option(
+        '-d',
+        '--db',
+        dest='db',
+        default=None,
+        help="Path to database file")
+    parser.add_option(
+        '-k',
+        '--key',
+        dest='key',
+        default=None,
+        help="Path to key file"
+    )
+    parser.add_option(
+        "-t",
+        "--template",
+        dest="template",
+        default=None,
+        help="Path to custom HTML template")
+    (options, args) = parser.parse_args()
+
+    if options.android and options.iphone:
+        print("You must define only one device type.")
+        exit(1)
+    if not options.android and not options.iphone:
+        print("You must define the device type.")
+        exit(1)
+    data = {}
+
+    if options.android:
+        contacts = extract.contacts
+        messages = extract.messages
+        media = extract.media
+        vcard = extract.vcard
+        create_html = extract.create_html
+        if options.db is None:
+            msg_db = "msgstore.db"
+        else:
+            msg_db = options.db
+        if options.key is not None:
+            if options.backup is None:
+                print("You must specify the backup file with -b")
+                exit(1)
+            print("Decryption key specified, decrypting WhatsApp backup...")
+            if "crypt12" in options.backup:
+                crypt = Crypt.CRYPT12
+            elif "crypt14" in options.backup:
+                crypt = Crypt.CRYPT14
+            elif "crypt15" in options.backup:
+                crypt = Crypt.CRYPT15
+            if os.path.isfile(options.key):
+                key = open(options.key, "rb")
+            elif all(char in string.hexdigits for char in options.key):
+                key = bytes.fromhex(options.key)
+            db = open(options.backup, "rb").read()
+            error = extract.decrypt_backup(db, key, msg_db, crypt)
+            if error != 0:
+                if error == 1:
+                    print("Dependencies of decrypt_backup and/or extract_encrypted_key"
+                          " are not present. For details, see README.md.")
+                    exit(3)
+                elif error == 2:
+                    print("Failed when decompressing the decrypted backup. "
+                          "Possibly incorrect offsets used in decryption.")
+                    exit(4)
+                else:
+                    print("Unknown error occurred.")
+                    exit(5)
+        if options.wa is None:
+            contact_db = "wa.db"
+        else:
+            contact_db = options.wa
+        if options.media is None:
+            options.media = "WhatsApp"
+
+        if len(args) == 1:
+            msg_db = args[0]
+
+        if os.path.isfile(contact_db):
+            with sqlite3.connect(contact_db) as db:
+                contacts(db, data)
+
+    elif options.iphone:
+        messages = extract_iphone.messages
+        media = extract_iphone.media
+        vcard = extract_iphone.vcard
+        create_html = extract_iphone.create_html
+        if options.backup is not None:
+            extract_iphone_media.extract_media(options.backup)
+        if options.db is None:
+            msg_db = "7c7fba66680ef796b916b067077cc246adacf01d"
+        else:
+            msg_db = options.db
+        if options.wa is None:
+            contact_db = "ContactsV2.sqlite"
+        else:
+            contact_db = options.wa
+        if options.media is None:
+            options.media = "Message"
+
+        if len(args) == 1:
+            msg_db = args[0]
+
+    if os.path.isfile(msg_db):
+        with sqlite3.connect(msg_db) as db:
+            messages(db, data)
+            media(db, data, options.media)
+            vcard(db, data)
+        create_html(data, options.output, options.template)
+    else:
+        print(
+            "The message database does not exist. You may specify the path "
+            "to database file with option -d or check your provided path.",
+            end="\r"
+        )
+        exit(2)
+
+    if os.path.isdir(options.media) and \
+            not os.path.isdir(f"{options.output}/{options.media}"):
+        try:
+            shutil.move(options.media, f"{options.output}/")
+        except PermissionError:
+            print("Cannot remove original WhatsApp directory. "
+                  "Perhaps the directory is opened?")
+
+    if options.json:
+        with open("result.json", "w") as f:
+            data = json.dumps(data)
+            print(f"\nWriting JSON file...({int(len(data)/1024/1024)}MB)")
+            f.write(data)
+    else:
+        print()
+
+    print("Everything is done!")

Whatsapp_Chat_Exporter/extract.py

@@ -7,8 +7,33 @@ import os
 import requests
 import shutil
 import re
+import pkgutil
+import io
+import hmac
+from pathlib import Path
+from bleach import clean as sanitize
+from markupsafe import Markup
 from datetime import datetime
+from enum import Enum
 from mimetypes import MimeTypes
+from hashlib import sha256
+
+try:
+    import zlib
+    from Crypto.Cipher import AES
+except ModuleNotFoundError:
+    support_backup = False
+else:
+    support_backup = True
+try:
+    import javaobj
+except ModuleNotFoundError:
+    support_crypt15 = False
+else:
+    support_crypt15 = True
+
+def sanitize_except(html):
+    return Markup(sanitize(html, tags=["br"]))
 
 
 def determine_day(last, current):
@@ -19,6 +44,136 @@ def determine_day(last, current):
     else:
         return current
 
+CRYPT14_OFFSETS = [
+    {"iv": 67, "db": 191},
+    {"iv": 67, "db": 190},
+    {"iv": 66, "db": 99}
+]
+
+
+class Crypt(Enum):
+    CRYPT15 = 15
+    CRYPT14 = 14
+    CRYPT12 = 12
+
+
+def brute_force_offset():
+    for iv in range(0, 200):
+        for db in range(0, 200):
+            yield iv, iv + 16, db
+
+
+def _generate_hmac_of_hmac(key_stream):
+    key = hmac.new(
+        hmac.new(
+            b'\x00' * 32,
+            key_stream,
+            sha256
+        ).digest(),
+        b"backup encryption\x01",
+        sha256
+    )
+    return key.digest()
+
+
+def _extract_encrypted_key(keyfile):
+    key_stream = b""
+    for byte in javaobj.loads(keyfile):
+        key_stream += byte.to_bytes(1, "big", signed=True)
+
+    return _generate_hmac_of_hmac(key_stream)
+    
+
+def decrypt_backup(database, key, output, crypt=Crypt.CRYPT14):
+    if not support_backup:
+        return 1
+    if isinstance(key, io.IOBase):
+        key = key.read()
+        if crypt is not Crypt.CRYPT15:
+            t1 = key[30:62]
+    if crypt is not Crypt.CRYPT15 and len(key) != 158:
+        raise ValueError("The key file must be 158 bytes")
+    if crypt == Crypt.CRYPT14:
+        if len(database) < 191:
+            raise ValueError("The crypt14 file must be at least 191 bytes")
+        current_try = 0
+        offsets = CRYPT14_OFFSETS[current_try]
+        t2 = database[15:47]
+        iv = database[offsets["iv"]:offsets["iv"] + 16]
+        db_ciphertext = database[offsets["db"]:]
+    elif crypt == Crypt.CRYPT12:
+        if len(database) < 67:
+            raise ValueError("The crypt12 file must be at least 67 bytes")
+        t2 = database[3:35]
+        iv = database[51:67]
+        db_ciphertext = database[67:-20]
+    elif crypt == Crypt.CRYPT15:
+        if not support_crypt15:
+            return 1
+        if len(database) < 131:
+            raise ValueError("The crypt15 file must be at least 131 bytes")
+        t1 = t2 = None
+        iv = database[8:24]
+        db_ciphertext = database[131:]
+
+    if t1 != t2:
+        raise ValueError("The signature of key file and backup file mismatch")
+
+    if crypt == Crypt.CRYPT15:
+        if len(key) == 32:
+            main_key = _generate_hmac_of_hmac(key)
+        else:
+            main_key = _extract_encrypted_key(key)
+    else:
+        main_key = key[126:]
+    decompressed = False
+    while not decompressed:
+        cipher = AES.new(main_key, AES.MODE_GCM, iv)
+        db_compressed = cipher.decrypt(db_ciphertext)
+        try:
+            db = zlib.decompress(db_compressed)
+        except zlib.error:
+            if crypt == Crypt.CRYPT14:
+                current_try += 1
+                if current_try < len(CRYPT14_OFFSETS):
+                    offsets = CRYPT14_OFFSETS[current_try]
+                    iv = database[offsets["iv"]:offsets["iv"] + 16]
+                    db_ciphertext = database[offsets["db"]:]
+                    continue
+                else:
+                    print("Common offsets are not applicable to "
+                          "your backup. Trying to brute force it...")
+                    for start_iv, end_iv, start_db in brute_force_offset():
+                        iv = database[start_iv:end_iv]
+                        db_ciphertext = database[start_db:]
+                        cipher = AES.new(main_key, AES.MODE_GCM, iv)
+                        db_compressed = cipher.decrypt(db_ciphertext)
+                        try:
+                            db = zlib.decompress(db_compressed)
+                        except zlib.error:
+                            continue
+                        else:
+                            decompressed = True
+                            print(
+                                f"The offsets of your IV and database are {start_iv} and "
+                                f"{start_db}, respectively. To include your offsets in the "
+                                "program, please report it by creating an issue on GitHub: "
+                                "https://github.com/KnugiHK/Whatsapp-Chat-Exporter/issues/new"
+                            )
+                            break
+                    if not decompressed:
+                        return 2
+            else:
+                return 3
+        else:
+            decompressed = True
+        if db[0:6].upper() == b"SQLITE":
+            with open(output, "wb") as f:
+                f.write(db)
+            return 0
+        else:
+            raise ValueError("The plaintext is not a SQLite database. Did you use the key to encrypt something...")
+
 
 def contacts(db, data):
     # Get contacts
@@ -71,7 +226,9 @@ def messages(db, data):
             "timestamp": content[3]/1000,
             "time": datetime.fromtimestamp(content[3]/1000).strftime("%H:%M"),
             "media": False,
-            "key_id": content[13]
+            "key_id": content[13],
+            "meta": False,
+            "data": None
         }
         if "-" in content[0] and content[2] == 0:
             name = None
@@ -106,8 +263,9 @@ def messages(db, data):
                     try:
                         int(content[4])
                     except ValueError:
-                        msg = "{The group name changed to "f"{content[4]}"" }"
+                        msg = f"The group name changed to {content[4]}"
                         data[content[0]]["messages"][content[1]]["data"] = msg
+                        data[content[0]]["messages"][content[1]]["meta"] = True
                     else:
                         del data[content[0]]["messages"][content[1]]
                 else:
@@ -126,15 +284,16 @@ def messages(db, data):
                                     name_left = data[content[8]]["name"]
                                 else:
                                     name_left = content[8].split('@')[0]
-                                msg = "{"f"{name_left}"f" added {name_right or 'You'}""}"
+                                msg = f"{name_left} added {name_right or 'You'}"
                             else:
-                                msg = "{"f"Added {name_right or 'You'}""}"
+                                msg = f"Added {name_right or 'You'}"
                         elif b"\xac\xed\x00\x05\x74\x00" in thumb_image:
                             # Changed number
                             original = content[8].split('@')[0]
                             changed = thumb_image[7:].decode().split('@')[0]
-                            msg = "{"f"{original} changed to {changed}""}"
+                            msg = f"{original} changed to {changed}"
                         data[content[0]]["messages"][content[1]]["data"] = msg
+                        data[content[0]]["messages"][content[1]]["meta"] = True
                     else:
                         if content[4] is None:
                             del data[content[0]]["messages"][content[1]]
@@ -146,20 +305,34 @@ def messages(db, data):
         else:
             if content[2] == 1:
                 if content[5] == 5 and content[6] == 7:
-                    msg = "{Message deleted}"
+                    msg = "Message deleted"
+                    data[content[0]]["messages"][content[1]]["meta"] = True
                 else:
                     if content[9] == "5":
-                        msg = "{ Location shared: "f"{content[10], content[11]}"" }"
+                        msg = f"Location shared: {content[10], content[11]}"
+                        data[content[0]]["messages"][content[1]]["meta"] = True
                     else:
                         msg = content[4]
+                        if msg is not None:
+                            if "\r\n" in msg:
+                                msg = msg.replace("\r\n", "<br>")
+                            if "\n" in msg:
+                                msg = msg.replace("\n", "<br>")
             else:
                 if content[5] == 0 and content[6] == 7:
-                    msg = "{Message deleted}"
+                    msg = "Message deleted"
+                    data[content[0]]["messages"][content[1]]["meta"] = True
                 else:
                     if content[9] == "5":
-                        msg = "{ Location shared: "f"{content[10], content[11]}"" }"
+                        msg = f"Location shared: {content[10], content[11]}"
+                        data[content[0]]["messages"][content[1]]["meta"] = True
                     else:
                         msg = content[4]
+                        if msg is not None:
+                            if "\r\n" in msg:
+                                msg = msg.replace("\r\n", "<br>")
+                            if "\n" in msg:
+                                msg = msg.replace("\n", "<br>")
 
             data[content[0]]["messages"][content[1]]["data"] = msg
 
@@ -167,8 +340,7 @@ def messages(db, data):
         if i % 1000 == 0:
             print(f"Gathering messages...({i}/{total_row_number})", end="\r")
         content = c.fetchone()
-    print(
-        f"Gathering messages...({total_row_number}/{total_row_number})", end="\r")
+    print(f"Gathering messages...({total_row_number}/{total_row_number})", end="\r")
 
 
 def media(db, data, media_folder):
@@ -214,8 +386,9 @@ def media(db, data, media_folder):
             # data[content[0]]["messages"][content[1]]["media"] = True
             # data[content[0]]["messages"][content[1]]["mime"] = "media"
             # else:
-            data[content[0]]["messages"][content[1]]["data"] = "{The media is missing}"
+            data[content[0]]["messages"][content[1]]["data"] = "The media is missing"
             data[content[0]]["messages"][content[1]]["mime"] = "media"
+            data[content[0]]["messages"][content[1]]["meta"] = True
         i += 1
         if i % 100 == 0:
             print(f"Gathering media...({i}/{total_row_number})", end="\r")
@@ -238,27 +411,34 @@ def vcard(db, data):
     total_row_number = len(rows)
     print(f"\nGathering vCards...(0/{total_row_number})", end="\r")
     base = "WhatsApp/vCards"
+    if not os.path.isdir(base):
+        Path(base).mkdir(parents=True, exist_ok=True)
     for index, row in enumerate(rows):
-        if not os.path.isdir(base):
-            os.mkdir(base)
         file_name = "".join(x for x in row[3] if x.isalnum())
         file_path = f"{base}/{file_name}.vcf"
         if not os.path.isfile(file_path):
             with open(file_path, "w", encoding="utf-8") as f:
                 f.write(row[2])
         data[row[1]]["messages"][row[0]]["data"] = row[3] + \
-            "{ The vCard file cannot be displayed here, however it " \
-            "should be located at " + file_path + "}"
+            "The vCard file cannot be displayed here, " \
+            f"however it should be located at {file_path}"
         data[row[1]]["messages"][row[0]]["mime"] = "text/x-vcard"
+        data[row[1]]["messages"][row[0]]["meta"] = True
         print(f"Gathering vCards...({index + 1}/{total_row_number})", end="\r")
 
 
-def create_html(data, output_folder):
-    templateLoader = jinja2.FileSystemLoader(searchpath="./")
+def create_html(data, output_folder, template=None):
+    if template is None:
+        template_dir = os.path.dirname(__file__)
+        template_file = "whatsapp.html"
+    else:
+        template_dir = os.path.dirname(template)
+        template_file = os.path.basename(template)
+    templateLoader = jinja2.FileSystemLoader(searchpath=template_dir)
     templateEnv = jinja2.Environment(loader=templateLoader)
     templateEnv.globals.update(determine_day=determine_day)
-    TEMPLATE_FILE = "whatsapp.html"
-    template = templateEnv.get_template(TEMPLATE_FILE)
+    templateEnv.filters['sanitize_except'] = sanitize_except
+    template = templateEnv.get_template(template_file)
 
     total_row_number = len(data)
     print(f"\nCreating HTML...(0/{total_row_number})", end="\r")

Whatsapp_Chat_Exporter/extract_iphone.py

@@ -6,12 +6,20 @@ import jinja2
 import os
 import requests
 import shutil
+import pkgutil
+from pathlib import Path
+from bleach import clean as sanitize
+from markupsafe import Markup
 from datetime import datetime
 from mimetypes import MimeTypes
 
 APPLE_TIME = datetime.timestamp(datetime(2001, 1, 1))
 
 
+def sanitize_except(html):
+    return Markup(sanitize(html, tags=["br"]))
+
+
 def determine_day(last, current):
     last = datetime.fromtimestamp(last).date()
     current = datetime.fromtimestamp(current).date()
@@ -61,7 +69,9 @@ def messages(db, data):
             "time": datetime.fromtimestamp(ts).strftime("%H:%M"),
             "media": False,
             "reply": None,
-            "caption": None
+            "caption": None,
+            "meta": False,
+            "data": None
         }
         if "-" in content[0] and content[2] == 0:
             name = None
@@ -86,8 +96,9 @@ def messages(db, data):
                     try:
                         int(content[4])
                     except ValueError:
-                        msg = "{The group name changed to "f"{content[4]}"" }"
+                        msg = f"The group name changed to {content[4]}"
                         data[content[0]]["messages"][content[1]]["data"] = msg
+                        data[content[0]]["messages"][content[1]]["meta"] = True
                     else:
                         del data[content[0]]["messages"][content[1]]
                 else:
@@ -98,14 +109,26 @@ def messages(db, data):
             # real message
             if content[2] == 1:
                 if content[5] == 14:
-                    msg = "{Message deleted}"
+                    msg = "Message deleted"
+                    data[content[0]]["messages"][content[1]]["meta"] = True
                 else:
                     msg = content[4]
+                    if msg is not None:
+                        if "\r\n" in msg:
+                            msg = msg.replace("\r\n", "<br>")
+                        if "\n" in msg:
+                            msg = msg.replace("\n", "<br>")
             else:
                 if content[5] == 14:
-                    msg = "{Message deleted}"
+                    msg = "Message deleted"
+                    data[content[0]]["messages"][content[1]]["meta"] = True
                 else:
                     msg = content[4]
+                    if msg is not None:
+                        if "\r\n" in msg:
+                            msg = msg.replace("\r\n", "<br>")
+                        if "\n" in msg:
+                            msg = msg.replace("\n", "<br>")
             data[content[0]]["messages"][content[1]]["data"] = msg
         i += 1
         if i % 1000 == 0:
@@ -137,7 +160,7 @@ def media(db, data, media_folder):
     content = c.fetchone()
     mime = MimeTypes()
     while content is not None:
-        file_path = f"Message/{content[2]}"
+        file_path = f"{media_folder}/{content[2]}"
         data[content[0]]["messages"][content[1]]["media"] = True
 
         if os.path.isfile(file_path):
@@ -160,8 +183,9 @@ def media(db, data, media_folder):
             # data[content[0]]["messages"][content[1]]["data"] = "{The media is missing}"
             # data[content[0]]["messages"][content[1]]["mime"] = "media"
             # else:
-            data[content[0]]["messages"][content[1]]["data"] = "{The media is missing}"
+            data[content[0]]["messages"][content[1]]["data"] = "The media is missing"
             data[content[0]]["messages"][content[1]]["mime"] = "media"
+            data[content[0]]["messages"][content[1]]["meta"] = True
         if content[6] is not None:
             data[content[0]]["messages"][content[1]]["caption"] = content[6]
         i += 1
@@ -189,28 +213,35 @@ def vcard(db, data):
     total_row_number = len(rows)
     print(f"\nGathering vCards...(0/{total_row_number})", end="\r")
     base = "Message/vCards"
+    if not os.path.isdir(base):
+        Path(base).mkdir(parents=True, exist_ok=True)
     for index, row in enumerate(rows):
-        if not os.path.isdir(base):
-            os.mkdir(base)
         file_name = "".join(x for x in row[3] if x.isalnum())
         file_path = f"{base}/{file_name[:200]}.vcf"
         if not os.path.isfile(file_path):
             with open(file_path, "w", encoding="utf-8") as f:
                 f.write(row[4])
         data[row[2]]["messages"][row[1]]["data"] = row[3] + \
-            "{ The vCard file cannot be displayed here, however it " \
-            "should be located at " + file_path + "}"
+            "The vCard file cannot be displayed here, " \
+            f"however it should be located at {file_path}"
         data[row[2]]["messages"][row[1]]["mime"] = "text/x-vcard"
         data[row[2]]["messages"][row[1]]["media"] = True
+        data[row[2]]["messages"][row[1]]["meta"] = True
         print(f"Gathering vCards...({index + 1}/{total_row_number})", end="\r")
 
 
-def create_html(data, output_folder):
-    templateLoader = jinja2.FileSystemLoader(searchpath="./")
+def create_html(data, output_folder, template=None):
+    if template is None:
+        template_dir = os.path.dirname(__file__)
+        template_file = "whatsapp.html"
+    else:
+        template_dir = os.path.dirname(template)
+        template_file = os.path.basename(template)
+    templateLoader = jinja2.FileSystemLoader(searchpath=template_dir)
     templateEnv = jinja2.Environment(loader=templateLoader)
     templateEnv.globals.update(determine_day=determine_day)
-    TEMPLATE_FILE = "whatsapp.html"
-    template = templateEnv.get_template(TEMPLATE_FILE)
+    templateEnv.filters['sanitize_except'] = sanitize_except
+    template = templateEnv.get_template(template_file)
 
     total_row_number = len(data)
     print(f"\nCreating HTML...(0/{total_row_number})", end="\r")

Whatsapp_Chat_Exporter/extract_iphone_media.py

@@ -0,0 +1,133 @@
+#!/usr/bin/python3
+
+import shutil
+import sqlite3
+import os
+import getpass
+try:
+    from iphone_backup_decrypt import EncryptedBackup, RelativePath
+except ModuleNotFoundError:
+    support_encrypted = False
+else:
+    support_encrypted = True
+
+
+def extract_encrypted(base_dir, password):
+    backup = EncryptedBackup(backup_directory=base_dir, passphrase=password)
+    print("Decrypting WhatsApp database...")
+    backup.extract_file(relative_path=RelativePath.WHATSAPP_MESSAGES,
+                        output_filename="7c7fba66680ef796b916b067077cc246adacf01d")
+    backup.extract_file(relative_path=RelativePath.WHATSAPP_CONTACTS,
+                        output_filename="ContactsV2.sqlite")
+    data = backup.execute_sql("""SELECT count()
+                                FROM Files
+                                WHERE relativePath
+                                    LIKE 'Message/Media/%'"""
+                              )
+    total_row_number = data[0][0]
+    print(f"Gathering media...(0/{total_row_number})", end="\r")
+    data = backup.execute_sql("""SELECT fileID,
+                                        relativePath,
+                                        flags,
+                                        file
+                                FROM Files
+                                WHERE relativePath
+                                    LIKE 'Message/Media/%'"""
+                              )
+    if not os.path.isdir("Message"):
+        os.mkdir("Message")
+    if not os.path.isdir("Message/Media"):
+        os.mkdir("Message/Media")
+    i = 0
+    for row in data:
+        destination = row[1]
+        hashes = row[0]
+        folder = hashes[:2]
+        flags = row[2]
+        file = row[3]
+        if flags == 2:
+            try:
+                os.mkdir(destination)
+            except FileExistsError:
+                pass
+        elif flags == 1:
+            decrypted = backup.decrypt_inner_file(file_id=hashes, file_bplist=file)
+            with open(destination, "wb") as f:
+                f.write(decrypted)
+        i += 1
+        if i % 100 == 0:
+            print(f"Gathering media...({i}/{total_row_number})", end="\r")
+    print(f"Gathering media...({total_row_number}/{total_row_number})", end="\r")
+
+
+def is_encrypted(base_dir):
+    with sqlite3.connect(f"{base_dir}/Manifest.db") as f:
+        c = f.cursor()
+        try:
+            c.execute("""SELECT count()
+                    FROM Files
+                    """)
+        except sqlite3.DatabaseError:
+            return True
+        else:
+            return False
+
+
+def extract_media(base_dir):
+    if is_encrypted(base_dir):
+        if not support_encrypted:
+            print("You don't have the dependencies to handle encrypted backup.")
+            print("Read more on how to deal with encrypted backup:")
+            print("https://github.com/KnugiHK/Whatsapp-Chat-Exporter/blob/main/README.md#usage")
+            return False
+        password = getpass.getpass("Enter the password:")
+        extract_encrypted(base_dir, password)
+    else:
+        wts_db = os.path.join(base_dir, "7c/7c7fba66680ef796b916b067077cc246adacf01d")
+        if not os.path.isfile(wts_db):
+            print("WhatsApp database not found.")
+            exit()
+        else:
+            shutil.copyfile(wts_db, "7c7fba66680ef796b916b067077cc246adacf01d")
+        with sqlite3.connect(f"{base_dir}/Manifest.db") as manifest:
+            c = manifest.cursor()
+            c.execute("""SELECT count()
+                        FROM Files
+                        WHERE relativePath
+                            LIKE 'Message/Media/%'""")
+            total_row_number = c.fetchone()[0]
+            print(f"Gathering media...(0/{total_row_number})", end="\r")
+            c.execute("""SELECT fileID,
+                                relativePath,
+                                flags
+                        FROM Files
+                        WHERE relativePath
+                            LIKE 'Message/Media/%'""")
+            row = c.fetchone()
+            if not os.path.isdir("Message"):
+                os.mkdir("Message")
+            if not os.path.isdir("Message/Media"):
+                os.mkdir("Message/Media")
+            i = 0
+            while row is not None:
+                destination = row[1]
+                hashes = row[0]
+                folder = hashes[:2]
+                flags = row[2]
+                if flags == 2:
+                    os.mkdir(destination)
+                elif flags == 1:
+                    shutil.copyfile(f"{base_dir}/{folder}/{hashes}", destination)
+                i += 1
+                if i % 100 == 0:
+                    print(f"Gathering media...({i}/{total_row_number})", end="\r")
+                row = c.fetchone()
+            print(f"Gathering media...({total_row_number}/{total_row_number})", end="\r")
+
+
+if __name__ == "__main__":
+    from optparse import OptionParser
+    parser = OptionParser()
+    (_, args) = parser.parse_args()
+    base_dir = args[0]
+    extract_media(base_dir)

Whatsapp_Chat_Exporter/whatsapp.html

@@ -72,29 +72,37 @@
 									<a href="#{{msg.reply}}" style="color: #168acc;">"{{ msg.quoted_data or 'media' }}"</a>
 								</div>
 							{% endif %}
-							{% if msg.media == false %}
-								{% filter escape %}{{ msg.data or "{This message is not supported yet}" | replace('\n', '<br>') }}{% endfilter %}
+							{% if msg.meta == true or msg.media == false and msg.data is none %}
+								<div style="text-align: center;" class="w3-panel w3-border-blue w3-pale-blue w3-rightbar w3-leftbar">
+								 	<p>{{ msg.data or 'This message is not supported' }}</p>
+							    </div>
 							{% else %}
-								{% if "image/" in msg.mime %}
-								<a href="{{ msg.data }}"><img src="{{ msg.data }}" /></a>
-								{% elif "audio/" in msg.mime %}
-								<audio controls="controls" autobuffer="autobuffer">
-									<source src="{{ msg.data }}" />
-								</audio>
-								{% elif "video/" in msg.mime %}
-								<video controls="controls" autobuffer="autobuffer">
-									<source src="{{ msg.data }}" />
-								</video>
-								{% elif "/" in msg.mime %}
-									{The file cannot be displayed here, however it should be located at {{ msg.data }}}
+								{% if msg.media == false %}
+								{{ msg.data | sanitize_except() }}
 								{% else %}
-									{% filter escape %}{{ msg.data }}{% endfilter %}
+									{% if "image/" in msg.mime %}
+									<a href="{{ msg.data }}"><img src="{{ msg.data }}" /></a>
+									{% elif "audio/" in msg.mime %}
+									<audio controls="controls" autobuffer="autobuffer">
+										<source src="{{ msg.data }}" />
+									</audio>
+									{% elif "video/" in msg.mime %}
+									<video controls="controls" autobuffer="autobuffer">
+										<source src="{{ msg.data }}" />
+									</video>
+									{% elif "/" in msg.mime %}
+										<div style="text-align: center;" class="w3-panel w3-border-blue w3-pale-blue w3-rightbar w3-leftbar">
+											<p>The file cannot be displayed here, however it should be located at {{ msg.data }}</p>
+										</div>
+									{% else %}
+										{% filter escape %}{{ msg.data }}{% endfilter %}
+									{% endif %}
+									{% if msg.caption is not none %}
+									<br>
+									{{ msg.caption }}
+									{% endif %}
 								{% endif %}
-								{% if msg.caption is not none %}
-								<br>
-								{{ msg.caption }}
 								{% endif %}
-							{% endif %}
 							</div>
 						</div>
 						<div class="w3-col m2 l2" style="padding-left: 10px"><img src="{{ my_avatar }}" onerror="this.style.display='none'"></div>
@@ -120,27 +128,35 @@
 									<a href="#{{msg.reply}}" style="color: #168acc;">"{{ msg.quoted_data or 'media' }}"</a>
 								</div>
 							{% endif %}
-							{% if msg.media == false %}
-								{% filter escape %}{{ msg.data or "{This message is not supported yet}" }}{% endfilter %}
+							{% if msg.meta == true or msg.media == false and msg.data is none %}
+								<div style="text-align: center;" class="w3-panel w3-border-blue w3-pale-blue w3-rightbar w3-leftbar">
+									<p>{{ msg.data or 'This message is not supported' }}</p>
+								</div>
 							{% else %}
-								{% if "image/" in msg.mime %}
-								<a href="{{ msg.data }}"><img src="{{ msg.data }}" /></a>
-								{% elif "audio/" in msg.mime %}
-								<audio controls="controls" autobuffer="autobuffer">
-									<source src="{{ msg.data }}" />
-								</audio>
-								{% elif "video/" in msg.mime %}
-								<video controls="controls" autobuffer="autobuffer">
-									<source src="{{ msg.data }}" />
-								</video>
-								{% elif "/" in msg.mime %}
-									{The file cannot be displayed here, however it should be located at {{ msg.data }}}
+								{% if msg.media == false %}
+								{{ msg.data | sanitize_except() }}
 								{% else %}
-									{% filter escape %}{{ msg.data }}{% endfilter %}
-								{% endif %}
-								{% if msg.caption is not none %}
-								<br>
-								{{ msg.caption }}
+									{% if "image/" in msg.mime %}
+									<a href="{{ msg.data }}"><img src="{{ msg.data }}" /></a>
+									{% elif "audio/" in msg.mime %}
+									<audio controls="controls" autobuffer="autobuffer">
+										<source src="{{ msg.data }}" />
+									</audio>
+									{% elif "video/" in msg.mime %}
+									<video controls="controls" autobuffer="autobuffer">
+										<source src="{{ msg.data }}" />
+									</video>
+									{% elif "/" in msg.mime %}
+										<div style="text-align: center;" class="w3-panel w3-border-blue w3-pale-blue w3-rightbar w3-leftbar">
+											<p>The file cannot be displayed here, however it should be located at {{ msg.data }}</p>
+										</div>
+									{% else %}
+										{% filter escape %}{{ msg.data }}{% endfilter %}
+									{% endif %}
+									{% if msg.caption is not none %}
+									<br>
+									{{ msg.caption }}
+									{% endif %}
 								{% endif %}
 							{% endif %}
 							</div>

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

extract_iphone_media.py

@@ -1,50 +0,0 @@
-#!/usr/bin/python3
-
-import shutil
-import sqlite3
-import os
-
-
-def extract_media(base_dir):
-    with sqlite3.connect(f"{base_dir}/Manifest.db") as manifest:
-        c = manifest.cursor()
-        c.execute("""SELECT count()
-                    FROM Files
-                    WHERE relativePath
-                        LIKE 'Message/Media/%'""")
-        total_row_number = c.fetchone()[0]
-        print(f"Gathering media...(0/{total_row_number})", end="\r")
-        c.execute("""SELECT fileID,
-                            relativePath,
-                            flags
-                    FROM Files
-                    WHERE relativePath
-                        LIKE 'Message/Media/%'""")
-        row = c.fetchone()
-        if not os.path.isdir("Message"):
-            os.mkdir("Message")
-        if not os.path.isdir("Message/Media"):
-            os.mkdir("Message/Media")
-        i = 0
-        while row is not None:
-            destination = row[1]
-            hashes = row[0]
-            folder = hashes[:2]
-            flags = row[2]
-            if flags == 2:
-                os.mkdir(destination)
-            elif flags == 1:
-                shutil.copyfile(f"{base_dir}/{folder}/{hashes}", destination)
-            i += 1
-            if i % 100 == 0:
-                print(f"Gathering media...({i}/{total_row_number})", end="\r")
-            row = c.fetchone()
-        print(f"Gathering media...({total_row_number}/{total_row_number})", end="\r")
-
-
-if __name__ == "__main__":
-    from optparse import OptionParser
-    parser = OptionParser()
-    (_, args) = parser.parse_args()
-    base_dir = args[0]
-    extract_media(base_dir)

old_README.md

@@ -0,0 +1,34 @@
+# Whatsapp-Chat-Exporter
+A Whatsapp database parser that will give you the history of your Whatsapp conversations in HTML and JSON  
+**If you plan to uninstall WhatsApp or delete your WhatsApp account, please make a backup of your WhatsApp database. You may want to use this exporter again on the same database in the future as the exporter develops**
+
+# Usage
+First, clone this repo, and copy all py and html files to a working directory if you want to do so.
+```shell
+git clone https://github.com/KnugiHK/Whatsapp-Chat-Exporter.git
+```
+Then, ready your WhatsApp database, place them in the root of working directory.
+* For Android, it is called msgstore.db. If you want name of your contacts, get the contact database, which is called wa.db.
+* For iPhone, it is called 7c7fba66680ef796b916b067077cc246adacf01d (YES, a hash).
+
+Next, ready your media folder, place it in the root of working directory.
+* For Android, copy the WhatsApp directory from your phone directly.
+* For iPhone, run the extract_iphone_media.py, and you will get a folder called Message.
+```
+python extract_iphone_media.py "C:\Users\[Username]\AppData\Roaming\Apple Computer\MobileSync\Backup\[device id]"
+```
+And now, you should have something like this:
+
+![Folder structure](imgs/structure.png)
+
+Last, run the script regarding the type of phone.
+```
+python extract.py & :: Android
+python extract_iphone.py & :: iPhone
+```
+And you will get these:
+#### Private Message
+![Private Message](imgs/pm.png)
+
+#### Group Message
+![Group Message](imgs/group.png)

setup.py

@@ -0,0 +1,54 @@
+import setuptools
+from re import search
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+with open("Whatsapp_Chat_Exporter/__init__.py", encoding="utf8") as f:
+    version = search(r'__version__ = "(.*?)"', f.read()).group(1)
+
+setuptools.setup(
+    name="whatsapp-chat-exporter",
+    version=version,
+    author="KnugiHK",
+    author_email="info@knugi.com",
+    description="A Whatsapp database parser that will give you the "
+                "history of your Whatsapp conversations in HTML and JSON.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/KnugiHK/Whatsapp-Chat-Exporter",
+    packages=setuptools.find_packages(),
+    package_data={
+        '': ['whatsapp.html']
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "Intended Audience :: End Users/Desktop",
+        "Topic :: Communications :: Chat",
+        "Topic :: Utilities",
+        "Topic :: Database"
+    ],
+    python_requires='>=3.7',
+    install_requires=[
+       'jinja2',
+       'bleach'
+    ],
+    extras_require={
+        'android_backup':  ["pycryptodome"],
+        'crypt12':  ["pycryptodome"],
+        'crypt12':  ["pycryptodome"],
+        'crypt15':  ["pycryptodome", "javaobj-py3"]
+    },
+    entry_points={
+        "console_scripts": [
+            "wtsexporter = Whatsapp_Chat_Exporter.__main__:main"
+        ]
+    }
+)