ep_email_notifications/static/js/ep_email.js

var cookie = require('ep_etherpad-lite/static/js/pad_cookie').padcookie;
var optionsAlreadyRecovered = false;

if(typeof exports == 'undefined'){
  var exports = this['mymodule'] = {};
}

exports.postAceInit = function(hook, context){
  // If panelDisplayLocation setting is missing, set default value
  if (typeof clientVars.panelDisplayLocation != "object") {
    clientVars.panelDisplayLocation = {
       mysettings: true,  // In the "mysettings" menu
       popup: true
    }
  }

  // If plugin settings set panel form in mysettings menu
  if (clientVars.panelDisplayLocation.mysettings == true) {
    // Uncheck the checkbox incase of reminiscence
    $('#options-emailNotifications').prop('checked', false);

    $('#options-emailNotifications').on('click', function() {
      if (!optionsAlreadyRecovered) {
        getDataForUserId('ep_email_form_mysettings');
        optionsAlreadyRecovered = true;
      } else {
        $('.ep_email_settings').slideToggle();
      }
    });

    // Prepare subscription before submit form
    $('[name=ep_email_subscribe]').on('click', function(e) {
      $('[name=ep_email_option]').val('subscribe');
      checkAndSend(e);
    });

    // Prepare unsubscription before submit form
    $('[name=ep_email_unsubscribe]').on('click', function(e) {
      $('[name=ep_email_option]').val('unsubscribe');
      checkAndSend(e);
    });

    // subscribe by email can be active..
    $('#ep_email_form_mysettings').submit(function(){
      sendEmailToServer('ep_email_form_mysettings');
      return false;
    });
  } else {
    // Hide the notification menu in mysettings
    $('#options-emailNotifications').parent().hide();
  }

  // If settings set popup panel form to true, show it
  if (clientVars.panelDisplayLocation.popup == true) {
    // after 10 seconds if we dont already have an email for this author then prompt them
    setTimeout(function(){initPopupForm()},10000);
  }
}

exports.handleClientMessage_emailSubscriptionSuccess = function(hook, context){ // was subscribing to the email a big win or fail?
  if(context.payload.success == false) {
    showAlreadyRegistered(context.payload.type);
    $('#' + context.payload.formName + ' [name=ep_email]').select();
  } else {
    showRegistrationSuccess();

    // Add cookie to say an email is registered for this pad
    cookie.setPref(pad.getPadId() + "email", "true");

    if (clientVars.panelDisplayLocation.mysettings == true && $('.ep_email_settings').is(":visible")) {
      $('.ep_email_settings').slideToggle();
      $('#options-emailNotifications').prop('checked', false);
    }

    if (clientVars.panelDisplayLocation.popup == true && $('#ep_email_form_popup').is(":visible")) {
      $('#ep_email_form_popup').parent().parent().parent().hide();
    }
  }
}

exports.handleClientMessage_emailUnsubscriptionSuccess = function(hook, context){ // was subscribing to the email a big win or fail?
  if(context.payload.success == false) {
    showWasNotRegistered();
    $('#' + context.payload.formName + ' [name=ep_email]').select();
  } else {
    showUnregistrationSuccess();

    // Set cookie to say no email is registered for this pad
    cookie.setPref(pad.getPadId() + "email", "false");

    if (clientVars.panelDisplayLocation.mysettings == true && $('.ep_email_settings').is(":visible")) {
      $('.ep_email_settings').slideToggle();
      $('#options-emailNotifications').prop('checked', false);
    }

    if (clientVars.panelDisplayLocation.popup == true && $('#ep_email_form_popup').is(":visible")) {
      $('#ep_email_form_popup').parent().parent().parent().hide();
    }
  }
}

exports.handleClientMessage_emailNotificationGetUserInfo = function (hook, context) { // return the existing options for this userId
  var result = context.payload;

  // Only use first data from the server. (case when 2 emails subscribed for the same pad & authorId)
  if ($('.ep_email_settings').is(':visible') == false) {
    if(result.success == true){ // If data found, set the options with them
      $('[name=ep_email]').val(result.email);
      $('[name=ep_email_onStart]').prop('checked', result.onStart);
      $('[name=ep_email_onEnd]').prop('checked', result.onEnd);
    } else {  // No data found, set the options to default values
      $('[name=ep_email_onStart]').prop('checked', true);
      $('[name=ep_email_onEnd]').prop('checked', false);
    }

    if (result.formName == 'ep_email_form_mysettings') {
      $('.ep_email_settings').slideToggle();
    }
  }
}

exports.handleClientMessage_emailNotificationMissingParams = function (hook, context) { // Settings are missing in settings.json file
  if (context.payload == true) {
    $.gritter.add({
      // (string | mandatory) the heading of the notification
      title: window._('ep_email_notifications.titleGritterError'),
      // (string | mandatory) the text inside the notification
      text: window._('ep_email_notifications.msgParamsMissing'),
      // (bool | optional) if you want it to fade out on its own or just sit there
      sticky: true,
      // (string | optional) add a class name to the gritter msg
      class_name: "emailNotificationsParamsMissing"
    });

    // Hide the notification menu in mysettings
    if (clientVars.panelDisplayLocation.mysettings == true && $('.ep_email_settings').is(":visible")) {
      $('.ep_email_settings').slideToggle();
      $('#options-emailNotifications').prop('checked', false);
      $('#options-emailNotifications').parent().hide();
    }

    // Hide the popup if it is visible
    if (clientVars.panelDisplayLocation.popup == true && $('#ep_email_form_popup').is(":visible")) {
      $('#ep_email_form_popup').parent().parent().parent().hide();
    }
  }
}

/**
 * Initialize the popup panel form for subscription
 */
function initPopupForm(){
  var popUpIsAlreadyVisible = $('#ep_email_form_popup').is(":visible");
  if(!popUpIsAlreadyVisible){ // if the popup isn't already visible
    var cookieVal = pad.getPadId() + "email";
    if(cookie.getPref(cookieVal) !== "true"){ // if this user hasn't already subscribed
      askClientToEnterEmail(); // ask the client to register TODO uncomment me for a pop up
    }
  }
}

function clientHasAlreadyRegistered(){ // Has the client already registered for emails on this?
  // Given a specific AuthorID do we have an email address in the database?
  // Given that email address is it registered to this pad?
  // need to pass the server a message to check
  var userId = pad.getUserId();
  var message = {};
  message.type = 'USERINFO_AUTHOR_EMAIL_IS_REGISTERED_TO_PAD';
  message.userInfo = {};
  message.userInfo.userId = userId;
  pad.collabClient.sendMessage(message);
}

function askClientToEnterEmail(){
  var formContent = $('.ep_email_settings')
    .html()
    .replace('ep_email_form_mysettings', 'ep_email_form_popup');

  $.gritter.add({
    // (string | mandatory) the heading of the notification
    title: window._('ep_email_notifications.titleGritterSubscr'),
    // (string | mandatory) the text inside the notification
    text: "<p class='ep_email_form_popup_header'>" + window._('ep_email_notifications.headerGritterSubscr') + "</p>" + formContent,
    // (bool | optional) if you want it to fade out on its own or just sit there
    sticky: true,
    // (int | optional) the time you want it to be alive for before fading out
    time: 2000,
    // (string | optional) add a class name to the gritter msg
    class_name: "emailNotificationsPopupForm",
    // the function to bind to the form
    after_open: function(e){
      $('#ep_email_form_popup').submit(function(){
        sendEmailToServer('ep_email_form_popup');
        return false;
      });

      // Prepare subscription before submit form
      $('#ep_email_form_popup [name=ep_email_subscribe]').on('click', function(e) {
        $('#ep_email_form_popup [name=ep_email_option]').val('subscribe');
        checkAndSend(e);
      });

      // Prepare unsubscription before submit form
      $('#ep_email_form_popup [name=ep_email_unsubscribe]').on('click', function(e) {
        $('#ep_email_form_popup [name=ep_email_option]').val('unsubscribe');
        checkAndSend(e);
      });

      getDataForUserId('ep_email_form_popup');
      optionsAlreadyRecovered = true;
    }
  });
}

/**
 * Control options before submitting the form
 */
function checkAndSend(e) {
  var formName = $(e.currentTarget.parentNode).attr('id');

  var email = $('#' + formName + ' [name=ep_email]').val();

  if (email && $('#' + formName + ' [name=ep_email_option]').val() == 'subscribe'
      && !$('#' + formName + ' [name=ep_email_onStart]').is(':checked')
      && !$('#' + formName + ' [name=ep_email_onEnd]').is(':checked')) {
    $.gritter.add({
      // (string | mandatory) the heading of the notification
      title: window._('ep_email_notifications.titleGritterError'),
      // (string | mandatory) the text inside the notification
      text: window._('ep_email_notifications.msgOptionsNotChecked'),
      // (string | optional) add a class name to the gritter msg
      class_name: "emailNotificationsSubscrOptionsMissing"
    });
  } else if (email) {
    $('#' + formName).submit();
  }
  return false;
}

/**
 * Ask the server to register the email
 */
function sendEmailToServer(formName){
  var email = $('#' + formName + ' [name=ep_email]').val();
  var userId = pad.getUserId();
  var message = {};
  message.type = 'USERINFO_UPDATE';
  message.userInfo = {};
  message.padId = pad.getPadId();
  message.userInfo.email = email;
  message.userInfo.email_option = $('#' + formName + ' [name=ep_email_option]').val();
  message.userInfo.email_onStart = $('#' + formName + ' [name=ep_email_onStart]').is(':checked');
  message.userInfo.email_onEnd = $('#' + formName + ' [name=ep_email_onEnd]').is(':checked');
  message.userInfo.formName = formName;
  message.userInfo.userId = userId;
  if(email){
    pad.collabClient.sendMessage(message);
  }
}

/**
 * Thanks to the userId, we can get back from the Db the options set for this user
 * and fill the fields with them
 */
function getDataForUserId(formName) {
  var userId = pad.getUserId();
  var message = {};
  message.type = 'USERINFO_GET';
  message.padId = pad.getPadId();
  message.userInfo = {};
  message.userInfo.userId = userId;
  message.userInfo.formName = formName;

  pad.collabClient.sendMessage(message);
}

/*************************************
Manage return msgs from server
*************************************/

/**
 * Show a successful registration message
 */
function showRegistrationSuccess(){
  $.gritter.add({
    // (string | mandatory) the heading of the notification
    title: window._('ep_email_notifications.titleGritterSubscr'),
    // (string | mandatory) the text inside the notification
    text: window._('ep_email_notifications.msgSubscrSuccess'),
    // (int | optional) the time you want it to be alive for before fading out
    time: 10000,
    // (string | optional) add a class name to the gritter msg
    class_name: "emailNotificationsSubscrResponseGood"
  });
}

/**
 * The client already registered for emails on this pad so notify the UI
 */
function showAlreadyRegistered(type){
  if (type == "malformedEmail") {
    var msg = window._('ep_email_notifications.msgEmailMalformed');
  } else if (type == "alreadyRegistered") {
    var msg = window._('ep_email_notifications.msgAlreadySubscr');
  } else {
    var msg = window._('ep_email_notifications.msgUnknownErr');
  }
  $.gritter.add({
    // (string | mandatory) the heading of the notification
    title: window._('ep_email_notifications.titleGritterSubscr'),
    // (string | mandatory) the text inside the notification
    text: msg,
    // (int | optional) the time you want it to be alive for before fading out
    time: 7000,
    // (string | optional) add a class name to the gritter msg
    class_name: "emailNotificationsSubscrResponseBad"
  });

}

/**
 * Show a successful unregistration message
 */
function showUnregistrationSuccess(){
  $.gritter.add({
    // (string | mandatory) the heading of the notification
    title: window._('ep_email_notifications.titleGritterUnsubscr'),
    // (string | mandatory) the text inside the notification
    text: window._('ep_email_notifications.msgUnsubscrSuccess'),
    // (int | optional) the time you want it to be alive for before fading out
    time: 10000,
    // (string | optional) add a class name to the gritter msg
    class_name: "emailNotificationsUnsubscrResponseGood"
  });
}

/**
 * The client wasn't registered for emails
 */
function showWasNotRegistered(){
  $.gritter.add({
    // (string | mandatory) the heading of the notification
    title: window._('ep_email_notifications.titleGritterUnsubscr'),
    // (string | mandatory) the text inside the notification
    text: window._('ep_email_notifications.msgUnsubscrNotExisting'),
    // (int | optional) the time you want it to be alive for before fading out
    time: 7000,
    // (string | optional) add a class name to the gritter msg
    class_name: "emailNotificationsUnsubscrResponseBad"
  });

}