zync_c4d_pvm_consent_dialog.py

""" Contains PVM consent dialog used in Zync plugin. """
from importlib import import_module
import webbrowser

from zync_c4d_constants import SYMBOLS
from zync_c4d_utils import init_c4d_resources, show_exceptions

c4d = import_module('c4d')
__res__ = init_c4d_resources()

from zync_c4d_utils import import_zync_module


class PvmConsentDialog(c4d.gui.GeDialog):
  """
  Implements the PVM consent dialog.

  This dialog informs the user about the risks of using preemptible instances.
  """

  def __init__(self):
    self.document = None
    self.result = None
    self.dont_show = None
    super(PvmConsentDialog, self).__init__()

  @show_exceptions
  def CreateLayout(self):
    """
    Creates UI controls.
    """
    self.LoadDialogResource(SYMBOLS['PVM_CONSENT_DIALOG'])
    return True

  @show_exceptions
  def Command(self, cmd_id, msg):
    """
    Handles user commands.
    """
    if cmd_id == SYMBOLS['LEARN_MORE']:
      webbrowser.open(
          'https://cloud.google.com/compute/docs/instances/preemptible')
    elif cmd_id == SYMBOLS['DONT_SHOW']:
      pass
    elif cmd_id == c4d.GEMB_R_OK:
      self.result = True
      self.dont_show = self.GetBool(SYMBOLS['DONT_SHOW'])
      self.Close()
    elif cmd_id == c4d.GEMB_R_CANCEL:
      self.result = False
      self.dont_show = False
      self.Close()
    else:
      raise Exception('Unknown command %s' % cmd_id)
    return super(PvmConsentDialog, self).Command(cmd_id, msg)


def get_pvm_consent_from_the_user():
  """
  Returns the state of the user consent for PVM terms of service.

  The dialog is shown that prompts the user to agree on PVM terms.
  If the user accepts and checks "don't show" checkbox, the dialog doesn't
  appear again and this function returns True.

  :return boolean: True if user consents and False otherwise.
  """
  settings = import_zync_module('settings')
  if not settings.Settings.get().get_pvm_ack():
    pvm_consent_dialog = PvmConsentDialog()
    pvm_consent_dialog.Open(dlgtype=c4d.DLG_TYPE_MODAL)
    if not pvm_consent_dialog.result:
      return False
    if pvm_consent_dialog.dont_show:
      settings.Settings.get().put_pvm_ack(True)
  return True