updater.py

import subprocess
import github
import datetime
import sys
#import os
#import pathlib
#import time
from threading import Lock

import settings
import logpipe
#import jjcommon

import jjlogger
logger = jjlogger.getLogger(__name__)

currentversion = None
latestversion = None
lastchecked = None

# get the current tag of the repo
def getCurrentVersion():
  global currentversion
  try:
    tag = subprocess.run(["git", "describe", "--tags", "--abbrev=0"], text=True, capture_output=True).stdout.strip()
  except subprocess.CalledProcessError:
    logger.warning("Could not determine current github repository version")
    tag = None
  logger.debug("determined current version: " + str(tag))
  currentversion = tag
  return tag

def getTimeSinceLastChecked():
  global lastchecked
  if lastchecked:
    return datetime.datetime.utcnow() - lastchecked
  else:
    return datetime.timedelta.max # first time, should encourage checking

# get latest version from github API
def getLatestVersion():
  global latestversion
  global lastchecked
  g = None
  repo = None
  rels = None
  try:
    g = github.Github(settings.getSettingValue("githubtoken"))
    repo = g.get_repo(settings.getSettingValue("githubrepo"))
    rels = repo.get_releases()
  except:
    logger.warning("Could not connect to github - abandoning update check")
    latestversion = None
  latestpub = datetime.datetime.min
  latestrel = None
  tag = None
  if rels:
    for r in rels:
      if r.published_at > latestpub:
        latestpub = r.published_at
        latestrel = r
    if latestrel:
      tag = latestrel.tag_name
      logger.info("Latest github repo version: " + tag)
    latestversion = tag
  lastchecked = datetime.datetime.utcnow()
  return tag

def setGitCredentials():
  subprocess.run(["git", "config", "--local", "credential.helper", "store"])
  githubuser = settings.getSettingValue("githubuser")
  githubpass = settings.getSettingValue("githubtoken")
  data = "username={0}\npassword={1}\nhost=github.com\nprotocol=https\n\n".format(githubuser,githubpass).encode()
  try:
    with subprocess.Popen(["git", "credential-store", "store"], stdout=subprocess.PIPE, stdin=subprocess.PIPE, stderr=subprocess.PIPE) as p:
      try:
        p.communicate(data, timeout=5)
      except subprocess.TimeoutExpired:
        logger.error("Git credential error - timeout.")
      else:
        logger.info("Git credentials updated")
  except subprocess.CalledProcessError as e:
    logger.error("Problem encountered attempting to store credentials: " + str(e))
  
# update to specified version - note this does not stop the program, this needs to be done separately
def doUpdate(tag=None):
  global latestversion
  global currentversion
  logger.debug(tag)
  ecode = 0
  if not tag:
    logger.debug("using latest version")
    tag = latestversion
  if not tag:
    logger.warning("Updater doesn't know the target version. Will not update.")
    ecode=1
  #elif tag == currentversion: # temporarily allow forced updating
  #  logger.warning("already this version. will not update.")
  else:
    logger.info("Updating now...")
    if "linux" in sys.platform:
      #updatescript = pathlib.Path(jjcommon.scriptpath).joinpath("update.sh").absolute()
      lp = logpipe.LogPipe(jjlogger.DEBUG, logger)
      try:      
        subprocess.run(["git", "fetch", "--all"], check=True, stderr=lp, stdout=lp)
        subprocess.run(["git", "reset", "--hard", tag], check=True, stderr=lp, stdout=lp)
        #subprocess.run(["git", "checkout", tag], check=True, stderr=lp, stdout=lp)
        #s = subprocess.Popen(["bash", str(updatescript), jjcommon.scriptpath, settings.getSettingValue("githubuser"), settings.getSettingValue("githubtoken"), tag])
      except subprocess.CalledProcessError as e:
        logger.error("Problem encountered during update: " + str(e))
        ecode=1
      else:
        # rely on update script to restart the service
        logger.info("Update complete, quitting now")
        ecode=0
      lp.close()
    else:
      logger.warning("Not able to update on this system, ignoring request to update.")
      ecode=1
  return ecode

# asks system to restart the service, and quits
#def restartService():
#  if "linux" in sys.platform:
#    logger.info("Requesting service restart...")
#    subprocess.Popen(["sudo", "systemctl", "restart", "jjclock.service"]) # if this is within the service, the progam should be terminated
#    time.sleep(1)
#    logger.error("Service was not terminated - this process probably not the service. quitting")
#    quit()
#  else:
#    logger.warning("No service to stop on this platform")