joplin2sql.py

import re
import os
import argparse
import sys
import errno
import optparse
import sqlite3
import uuid

import email
import email.utils
from email.message import EmailMessage
from email.parser import BytesParser, Parser
from email.policy import default

from datetime import datetime

import hashlib
import shutil

import notesdb
import constants
import common

#
# MIT License
#
# https://opensource.org/licenses/MIT
#
# Copyright 2020 Rene Sugar
#
# 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.

#
# Description:
#
# This program loads exported Joplin notes into a SQLite database.
#

global __name__, __author__, __email__, __version__, __license__
__program_name__ = 'joplin2sql'
__author__ = 'Rene Sugar'
__email__ = 'rene.sugar@gmail.com'
__version__ = '1.00'
__license__ = 'MIT License (https://opensource.org/licenses/MIT)'
__website__ = 'https://github.com/renesugar'
__db_schema_version__ = '1'
__db_schema_min_version__ = '1'

def _get_option_parser():
    parser = optparse.OptionParser('%prog [options]',
                                   version='%prog ' + __version__)
    parser.add_option('', "--email",
                      action="store", dest="email_address", default=None,
                      help="Email address")
    parser.add_option("", "--input",
                      action="store", dest="input_path", default=[],
                      help="Path to input iCloud notes archive")
    parser.add_option('', "--output",
                      action="store", dest="output_path", default=None,
                      help="Path to output SQLite directory")
    return parser

def process_joplin_note(sqlconn, resources_path, columns):
  note_title = columns['note_title']

  # note_title
  if columns["note_title"] is None:
    note_title = constants.NOTES_UNTITLED
  else:
    note_title = common.remove_line_breakers(columns["note_title"]).strip()

  print("processing '%s'" % (note_title,))

  # note_original_format (email, apple, icloud, joplin, bookmark)
  note_original_format = "joplin"

	# note_internal_date
  note_internal_date = columns['note_internal_date']

  # note_url
  note_url = columns['note_url']

  # note_data
  note_data = columns['note_data']
  if note_data is None:
    note_data = ''

  # note_data_format
  note_data_format = 'text/markdown'

	# note_hash (hash the markdown text)
  h = hashlib.sha512()
  h.update(note_data.encode('utf-8'))
  note_hash = h.hexdigest()

  # apple_id
  apple_id = None

  # apple_title
  apple_title = note_title

  # apple_snippet
  apple_snippet = note_title

  # apple_folder
  apple_folder = columns['apple_folder']
  if apple_folder is None:
    apple_folder = constants.NOTES_FOLDER_NAME

  # apple_created
  apple_created = note_internal_date.strftime("%Y-%m-%d %H:%M:%S.%f")

  # apple_last_modified
  apple_last_modified = apple_created

  # apple_data
  apple_data = note_data

  # apple_attachment_id
  apple_attachment_id = None

  # apple_attachment_path
  apple_attachment_path = None

  # Get resource attachments
  lines = note_data.split()
  links = common.getResourceLinks(lines)
  first_image = False
  for url, filename, resource in links:
    matches = common.getResourceFileName(resources_path, resource)
    if len(matches) > 0:
      filename = matches[0]
      mime_type, mime_subtype = common.getFileMimeType(filename)

      if mime_type != "image":
        # pick first non-image attachment as the Apple note attachment
        apple_attachment_id = common.format_univesally_unique_identifier(resource)
        apple_attachment_path = os.path.join(resources_path, filename)
        break
      elif first_image == False:
        first_image = True
        # otherwise, pick first image attachment as the Apple note attachment
        apple_attachment_id = common.format_univesally_unique_identifier(resource)
        apple_attachment_path = os.path.join(resources_path, filename)

  # apple_account_description
  apple_account_description = None

  # apple_account_identifier
  apple_account_identifier = None

  # apple_account_username
  apple_account_username = None

  # apple_version
  apple_version = None

  # apple_user
  apple_user = None

  # apple_source
  apple_source = None

  columns["note_original_format"] = note_original_format
  columns["note_internal_date"] = note_internal_date
  columns["note_hash"] = note_hash
  columns["note_title"] = note_title
  columns["note_data"] = note_data
  columns["note_data_format"] = note_data_format
  columns["note_url"] = note_url
  columns["apple_id"] = apple_id
  columns["apple_title"] = apple_title
  columns["apple_snippet"] = apple_snippet
  columns["apple_folder"] = apple_folder
  columns["apple_created"] = apple_created
  columns["apple_last_modified"] = apple_last_modified
  columns["apple_data"] = apple_data
  columns["apple_attachment_id"] = apple_attachment_id
  columns["apple_attachment_path"] = apple_attachment_path
  columns["apple_account_description"] = apple_account_description
  columns["apple_account_identifier"] = apple_account_identifier
  columns["apple_account_username"] = apple_account_username
  columns["apple_version"] = apple_version
  columns["apple_user"] = apple_user
  columns["apple_source"] = apple_source

  notesdb.add_joplin_note(sqlconn, columns)
  sqlconn.commit()

def parse_joplin_note(filePath):
  columns = {}
  if os.path.isfile(filePath) == True and common.checkExtension(filePath, ['md']):
    with open(filePath, 'r') as fp:
      lines = fp.readlines()
      end_of_props = 0
      for i in reversed(range(0, len(lines))):
        if lines[i] == '\n':
          end_of_props = i
          break
        key, val = lines[i].split(':', 1)

        columns['joplin_' + key] = val.strip()

      # Add missing Joplin columns
      for key in notesdb.joplinColumns:
        if key not in columns:
          columns[key] = None

      # Convert column string values to SQLite types
      joplin_column_types = dict(zip(notesdb.joplinColumns, notesdb.joplinColumnTypes))
      for key in columns:
        if joplin_column_types[key] == "INTEGER":
          if columns[key] is None:
            pass
          else:
            columns[key] = int(columns[key])
        elif joplin_column_types[key] == "FLOAT":
          if columns[key] is None:
            pass
          else:
            columns[key] = float(columns[key])
        else:
          pass

      columns["note_type"] = common.noteTypeFromJoplinType(columns['joplin_type_'])
      columns["note_uuid"] = columns["joplin_id"]
      columns["note_parent_uuid"] = columns["joplin_parent_id"]
      columns["note_tag_uuid"] = columns["joplin_tag_id"]
      columns["note_note_uuid"] = columns["joplin_note_id"]
      columns["note_original_format"] = 'joplin'
      columns["note_internal_date"] = common.parse_isoformat_datetime(columns['joplin_created_time'])
      columns["note_hash"] = None
      columns["note_title"] = common.defaultTitleFromBody(lines[0])
      columns["note_url"] = columns["joplin_source_url"]
      columns["note_data"] = ''.join(lines[0:end_of_props])
      columns["note_data_format"] = 'text/markdown'
      columns["apple_folder"] = None
  return columns

def main(args):
  parser = _get_option_parser()
  (options, args) = parser.parse_args(args)

  email_address = ''
  if hasattr(options, 'email_address') and options.email_address:
    email_address = options.email_address
    if common.check_email_address(email_address) == False:
      # Check if email address is valid
      common.error("email address '%s' is not valid." % (email_address,))
  else:
    common.error("email address not specified.")

  inputPath = ''

  if hasattr(options, 'input_path') and options.input_path:
    inputPath = os.path.abspath(os.path.expanduser(options.input_path))
    if os.path.isdir(inputPath) == False:
      # Check if input file exists
      common.error("input path '%s' does not exist." % (inputPath,))
  else:
    common.error("input path not specified.")

  outputPath = ''

  if hasattr(options, 'output_path') and options.output_path:
    outputPath = os.path.abspath(os.path.expanduser(options.output_path))
    if os.path.isdir(outputPath) == False:
      # Check if output directory exists
      common.error("output path '%s' does not exist." % (outputPath,))
  else:
    common.error("output path not specified.")
  
  inputResourcesPath = os.path.join(inputPath, 'resources')

  outputResourcesPath = os.path.join(outputPath, 'resources')

  notesdbfile = os.path.join(outputPath, 'notesdb.sqlite')

  new_database = (not os.path.isfile(notesdbfile))

  sqlconn = sqlite3.connect(notesdbfile,
    detect_types=sqlite3.PARSE_DECLTYPES)
  sqlcur = sqlconn.cursor()

  if (new_database):
    notesdb.create_database(sqlconn=sqlconn, db_schema_version=__db_schema_version__, email_address=options.email_address)
    
  db_settings = notesdb.get_db_settings(sqlcur, __db_schema_version__)
  notesdb.check_db_settings(db_settings, '%prog', __version__, __db_schema_min_version__, __db_schema_version__)

  # Create SQLite resources directory
  if not os.path.isdir(outputResourcesPath):
    os.makedirs(outputResourcesPath)

  # Copy resources from Joplin resources directory to SQLite resources directory
  for filename in os.listdir(inputResourcesPath):
    filePath = os.path.join(inputPath, filename)
    if os.path.isfile(filePath) == True:
      shutil.copy2(filePath, outputResourcesPath)

  # Parse Joplin notes
  for filename in os.listdir(inputPath):
    filePath = os.path.join(inputPath, filename)
    if os.path.isfile(filePath) == True and common.checkExtension(filename, ['md']):
      columns = parse_joplin_note(filePath)
      if int(columns['joplin_type_']) == constants.JoplinType.JOPLIN_TYPE_NOTE:
        if ('joplin_parent_id' in columns) and (columns['joplin_parent_id'] is not None):
          parentPath = os.path.join(inputPath, columns['joplin_parent_id'] + '.md')
          parent_columns = parse_joplin_note(parentPath)
          columns["apple_folder"] = parent_columns['note_title']
      process_joplin_note(sqlconn, outputResourcesPath, columns)

if __name__ == "__main__":
  main(sys.argv[1:])