mms.go

/*
SBRParser: SMS Backup & Restore Android app parser

Copyright (c) 2018 Dan O'Day <d@4n68r.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */

package smsbackuprestore

import (
	"path/filepath"
	"os"
	"strings"
	"fmt"
	"strconv"
	"time"
)

// DecodeImages identifies base64-encoded images in backed-up MMS messages and decodes them and outputs them to files
// with a unique file name tied to the MMS and part index numbers.
func DecodeImages(m *Messages, mainOutputDir string) (numImagesIdentified, numImagesSuccessfullyWritten int, errors []error) {
	numImagesIdentified = 0
	numImagesSuccessfullyWritten = 0

	// create output directory for images
	outputDir := filepath.Join(mainOutputDir, "images")
	os.MkdirAll(outputDir, os.ModePerm)

	for mmsIndex, mms := range m.MMS {
		t := time.Unix(int64(mms.Date) / int64(1000), 0)
		fnPrefix := t.Format("2006-01-02-150405")
		
		for partIndex, part := range mms.Parts {
			if strings.Contains(part.ContentType, "image/") {
				numImagesIdentified++
				outputImgFilename := fnPrefix + "-" + part.ImageFileName(mmsIndex, partIndex)

				// decode base64 image string as byte slice and write decoded byte slice to file
				outputPath := filepath.Join(outputDir, outputImgFilename)
				err := part.DecodeAndWriteImage(outputPath)
				if err != nil {
					errors = append(errors, err)
				} else {
					numImagesSuccessfullyWritten++
				}
			}
		}
	}
	return numImagesIdentified, numImagesSuccessfullyWritten, errors
}

// GenerateMMSOutput outputs a tab-delimited file named "mms.tsv" containing parsed MMS messages from the backup file.
func GenerateMMSOutput(m *Messages, outputDir string) error {
	mmsOutput, err := os.Create(filepath.Join(outputDir, "mms.tsv"))
	if err != nil {
		return fmt.Errorf("Unable to create file: mms.tsv\n%q", err)
	}
	defer mmsOutput.Close()

	// print header row
	headers := []string{
		"MMS Index #",
		"MMS Part Index #",
		"Text Only",
		"Read",
		"Date",
		"Locked",
		"Date Sent",
		"Readable Date",
		"Contact Name",
		"Seen",
		"From Address",
		"Address",
		"Addresses",
		"Message Classifier",
		"Message Size",
		"Part Content Type",
		"Part Name",
		"Part File Name",
		"Part Text",
		"Part Content Display",
		"Part Output Image Name",
	}
	fmt.Fprintf(mmsOutput, "%s\n", strings.Join(headers, "\t"))

	// iterate over mms
	for mmsIndex, mms := range m.MMS {
		var names []string
		var numbers []string
		var addresses []string
		var contactNameList string
		var addressList string
		addressesList := ""

		groupMessage := false
		if strings.Contains(mms.ContactName, ",") || strings.Contains(mms.Address.String(), "~") {
			groupMessage = true

			// get names
			for _, name := range strings.Split(RemoveCommasBeforeSuffixes(mms.ContactName), ",") {
				names = append(names, strings.TrimSpace(name))
			}

			// get/normalize phone numbers
			for _, number := range strings.Split(mms.Address.String(), "~") {
				numbers = append(numbers, PhoneNumber(number).String())
			}
		}

		// create semicolon-delimited output for group messages
		if groupMessage {
			// semicolon-delimited fields
			contactNameList = strings.Join(names, ";")
			addressList = strings.Join(numbers, ";")
		} else {
			contactNameList = RemoveCommasBeforeSuffixes(mms.ContactName)
			addressList = mms.Address.String()
		}

		// get any addresses for group message
		for _, addr := range mms.Addresses {
			addresses = append(addresses, addr.Address.String())
		}
		if len(addresses) > 0 {
			addressesList = strings.Join(addresses, ";")
		}

		for partIndex, part := range mms.Parts {
			imageFile := "N/A"
			if strings.Contains(part.ContentType, "image/") {
				imageFile = part.ImageFileName(mmsIndex, partIndex)
			}

			row := []string{
				strconv.Itoa(mmsIndex),
				strconv.Itoa(partIndex),
				mms.TextOnly.String(),
				mms.Read.String(),
				strconv.Itoa(mms.Date),
				mms.Locked.String(),
				mms.DateSent.String(),
				mms.ReadableDate,
				contactNameList,
				mms.Seen.String(),
				mms.FromAddress.String(),
				addressList,
				addressesList,
				mms.MessageClassifier,
				mms.MessageSize,
				part.ContentType,
				part.Name,
				part.FileName,
				CleanupMessageBody(part.Text),
				part.ContentDisplay,
				imageFile,
			}
			fmt.Fprintf(mmsOutput, "%s\n", strings.Join(row, "\t"))
		}
	}
	return nil
}