package.py

#!/usr/bin/env python3
import glob
import os
import re
import requests
import shutil
import subprocess
import tempfile
from urllib import request

SOURCE_FILES = [
  '__init__.py',
  'config.json',
]

# tuple of pypi_package_name, module_name
DEPENDENCIES_PYPI = [
  ('jieba', 'jieba'),
  ('cached_property', 'cached_property'),
  ('genanki', 'genanki'),
  ('chinesevocablist', 'chinesevocablist'),
  ('chineseflashcards', 'chineseflashcards'),
  ('pyyaml', 'yaml'),
  ('chevron', 'chevron'),
]

PACKAGE_CACHE_DIR = 'package_cache'

OUTPUT_FILE_NAME = "package.ankiaddon"


def prepare_package_dir_and_zip():
  shutil.rmtree('package', ignore_errors=True)
  os.mkdir('package')
  try:
    os.remove(OUTPUT_FILE_NAME)
  except OSError as e:
    if e.errno != 2:
      raise


def copy_source_files():
  for f in SOURCE_FILES:
    dirname, filename = os.path.split(f)
    target_dirname = os.path.join('package', dirname)
    os.makedirs(target_dirname, exist_ok=True)
    shutil.copy(f, target_dirname)


def retrieve_with_cache(url, dest_path):
  os.makedirs(PACKAGE_CACHE_DIR, exist_ok=True)

  filename = url.split('/')[-1]
  cached_path = os.path.join(PACKAGE_CACHE_DIR, filename)

  if not os.path.exists(cached_path):
    request.urlretrieve(url, cached_path)

  shutil.copy(cached_path, dest_path)

def copy_dependencies_from_pypi():
  for pypi_name, mod_name in DEPENDENCIES_PYPI:
    metadata = requests.get(f'https://pypi.org/pypi/{pypi_name}/json').json()
    latest_release = metadata['info']['version']
    url = metadata['releases'][latest_release][-1]['url']
    filename = url.split('/')[-1]

    tmpdir = tempfile.mkdtemp()
    retrieve_with_cache(url, os.path.join(tmpdir, filename))

    if filename.endswith('.zip'):
      subprocess.check_output(['unzip', filename], cwd=tmpdir)
      dirname = filename[:-len('.zip')]
    elif filename.endswith('.tar.gz'):
      subprocess.check_output(['tar', '-xzf', filename], cwd=tmpdir)
      dirname = filename[:-len('.tar.gz')]
    else:
      raise Exception(f'Unrecognized package format! {filename}')

    if mod_name == 'yaml':
      shutil.move(os.path.join(tmpdir, dirname, 'lib', mod_name), 'package')
    else:
      try:
        # this works if it's a directory
        shutil.move(os.path.join(tmpdir, dirname, mod_name), 'package')
      except FileNotFoundError:
        # this works if it's a simple .py file
        shutil.move(os.path.join(tmpdir, dirname, f'{mod_name}.py'), 'package')


def _extract_version(path):
  dirname = os.path.split(path)[-1]
  return re.search(r'[0-9]+(\.[0-9]+)*', dirname).group(0)


def _path_to_sort_tuple(path):
  # higher is better
  version_tuple = tuple(int(piece) for piece in _extract_version(path).split('.'))
  # prefer a package (rank higher) if it is user (rather than system)
  is_user = path.startswith(f'{os.environ["HOME"]}/.local/')
  return (is_user,) + version_tuple


def create_package_zip_file():
  shutil.copy('manifest.json', 'package/')
  subprocess.check_call(['zip', f'../{OUTPUT_FILE_NAME}', '-r', '.'], cwd='package')


prepare_package_dir_and_zip()
copy_source_files()
copy_dependencies_from_pypi()
create_package_zip_file()