background.js

// Copyright 2012 wtwf.com, All Rights Reserved.
// Created by: Alex K (wtwf.com)
/* global chrome, localStorage */

// TODO allow updating of patterns to batter ones.
// TODO we can expand short urls too!?
// TODO have a toolbar icon to turn this on and off
// TODO allow credit card looking numbers only for a short period of time?
// TODO allow you to send clipboard contents to other machines logged in with this user.

// NOTODO should we do http://amzn.com/ASIN ? not until it supports https

// The icons are creative commons (non-commercial) licensed from:
// http://www.ilmarin.info/gallery/album128/scissors01

var copyclipper = {} // Namespace

/** search and replace regexes
 *  !search!replace!regex_options
 * remember you can use $1, $2 etc in the replace string
 */
copyclipper.DEFAULT_REGEXES = [
  '# Add all new patterns above this line.',
  '# Begin Default Patterns',
  '# If you don\'t want one of thise patterns to execute, add a # at the start',
  '!\\?(fbclid|ref|authType)=.*!!',
  '!\\?filter=following.*!!',
  '!\\?fromListing=listing!!',
  '!\\?from_search=.*!!',
  '!\\?mt=[0-9]+!!',
  '!^(http.*)&referer=brief_results$!$1!',
  '!^(http.*)\\?_r=1$!$1!', // nytimes
  '!^(http.*)\\?feat=directlink$!$1!', // picasaweb
  '!^(http.*)\\?lang=en$!$1!',
  '!^(http.*)\\?source=rss$!$1!', // sentinel
  '!^(http.*)\\?utm_source=[^#]*!$1!', // GA
  '!^(http.*?)[&?]utm_(source|medium|campaign)=[^#]*!$1!',
  '!^(http.*imdb.com.*?)/?\\?.*!$1!',
  '!^(https://www.aliexpress.com/item).*(/\\d+\\.html)\\?.*!$1$2!',
  '!^(https://www.ebay.com/itm).*(/\\d+)\\?.*!$1/_$2!',
  '!^(https://www.homedepot.com/p).*(/\\d+)(\\?.*)?!$1/_$2!',
  '!^http.*google.*search.*[?&]tbm=isch&q=([^&]*).*$!https://www.google.com/search?tbm=isch&q=$1!',
  '!^http.*youtube.*[&?]v=([^&]*).*?(#t=.*)?$!https://youtu.be/$1$2!',
  '!^https://code.google.com/p/chromium/issues/detail\\?([^&]*&)*id=(\\d+).*$!http://crbug.com/$2!',
  '!^https?://([a-z0-9.]*amazon[^/]*/(gp/product|([^/]*/)?[dg]p)/[^/?]*).*$!https://$1!',
  '!^https://[^/]*\\.google\\.[^/]*/url\\?q=([^&]*).*!$1!u',
  '# Uncomment this next line (remove the #) if you feel brave!',
  '#!/index\\.(php|s?html?|asp)$!/!',
  '# End Default Patterns'
]

/** How long to wait before the Chrome notification disappears, in milliseconds. */
copyclipper.NOTIFICATION_TIMEOUT = 8000

/** Is an object empty.
 * @param {Object} obj the object to check.
 * @return {bool} true if object has properties.
 */
copyclipper.isEmpty = function (obj) {
  for (var i in obj) {
    if (Object.prototype.hasOwnProperty.call(obj, i)) {
      return false
    }
  }
  return true
}

copyclipper.restoreRegexes = function () {
  // try and get the data from chrome.storage.sync
  chrome.storage.sync.get('regexes', function (reply) {
    var regexes
    if (copyclipper.isEmpty(reply)) {
      // maybe they are in localStorage?
      if (Object.prototype.hasOwnProperty.call(localStorage, 'copyclipper.regexes') &&
          localStorage['copyclipper.regexes']) {
        console.log('loaded regexes from localStorage')
        regexes = localStorage['copyclipper.regexes']
      } else {
        console.log('no regexes found, using defaults')
        regexes = copyclipper.DEFAULT_REGEXES.join('\n')
      }
      chrome.storage.sync.set({ regexes: regexes }, function () {
        console.log('regexes saved to chrome.storage.sync')
      })
    } else {
      console.log('loaded regexes from chrome.storage.sync')
      regexes = reply.regexes
    }
    copyclipper.patterns = copyclipper.decodeRegexes(regexes)
  })
}

copyclipper.decodeRegexes = function (regexBlob) {
  var regexLines = regexBlob.split('\n')
  var patterns = []
  for (var i = 0; i < regexLines.length; i++) {
    var pattern = copyclipper.decodeRegexLine(regexLines[i])
    if (pattern) {
      patterns.push(pattern)
    }
  }
  return patterns
}

/** Remove whitespace from the start & end of the line. */
copyclipper.trim = function (s) {
  return s.replace(/^\s+/, '').replace(/\s+$/, '')
}

/** Take a line like !search!replace!re_args and turn it into a
 * Two element [RegExp, string] Array.
 * Returns null on comment lines or an error parsing.
 */
copyclipper.decodeRegexLine = function (regexLine) {
  console.log(regexLine)

  regexLine = copyclipper.trim(regexLine)
  if (regexLine.charAt(0) === '#') {
    // ignore comment lines
    return null
  }

  var oldParts = regexLine.split('!')
  var pos = 1
  var parts = []

  while (pos < oldParts.length) {
    parts.push(oldParts[pos++])
    while (oldParts[pos - 1].charAt(oldParts[pos - 1].length - 1) === '\\' &&
           pos < oldParts.length) {
      parts[parts.length - 1] = parts[parts.length - 1] + '!' + oldParts[pos]
      pos++
    }
  }
  if (parts.length === 3) {
    var newopts = parts[2].replace('u', '')
    var options = {}
    if (newopts !== parts[2]) {
      options.urlDecode = true
    }
    return [RegExp(parts[0], newopts), parts[1], options]
  }
  return null
}

copyclipper.textToHtml = function (txt) {
  txt = txt.replace('&', '&amp;')
  txt = txt.replace('<', '&lt;')
  txt = txt.replace('>', '&gt;')
  return txt
}

copyclipper.getClipboardContents = function () {
  var el = document.getElementById('txt')
  el.focus()
  el.select()
  document.execCommand('paste')
  return el.value
}

copyclipper.setClipboardContents = function (val) {
  var el = document.getElementById('txt')
  el.value = val
  el.focus()
  el.select()
  document.execCommand('copy')
  copyclipper.clipboardValue = val
}

/** Go through all our patterns and search/replace on val. */
copyclipper.replace = function (val, patterns) {
  if (patterns && patterns.length) {
    for (var i = 0; i < patterns.length; i++) {
      var search = patterns[i][0]
      var replace = patterns[i][1]
      var { urlDecode } = patterns[i][2] || {}
      var newval = val.replace(search, replace)
      if (newval !== val && urlDecode && newval.search(/\?[^=%]+%3D/)) {
        newval = copyclipper.replace(decodeURIComponent(newval))
      }
      val = newval
    }
  }
  return val
}

/** Called when the clipboard has changed, see if we can clip the clipboard. */
copyclipper.copyclip = function () {
  var val = copyclipper.getClipboardContents()
  var orig = val + ''

  val = copyclipper.replace(val, copyclipper.patterns)

  copyclipper.clipboardValue = val
  copyclipper.clipboardValueOriginal = orig
  if (val !== orig) {
    copyclipper.setClipboardContents(val)
    copyclipper.createNotification()
  }
}

/** Called every second to see if the clipboard has changed. */
copyclipper.pollClipboard = function () {
  var val = copyclipper.getClipboardContents()
  if (val !== copyclipper.clipboardValue) {
    copyclipper.copyclip()
  }
}

copyclipper.restoreRegexes()
copyclipper.clipboardValue = '' // the last value we saw
copyclipper.clipboardValueOriginal = ''

/*
navigator.permissions.query({
  name: 'clipboard-read'
}).then(permissionStatus => {
  // Will be 'granted', 'denied' or 'prompt':
  console.log(permissionStatus.state);

  // Listen for changes to the permission state
  permissionStatus.onchange = () => {
    console.log(permissionStatus.state);
  };
});
*/

function getChromeVersion () {
  var raw = navigator.userAgent.match(/Chrom(e|ium)\/([0-9]+)\./)
  return raw ? parseInt(raw[2], 10) : false
}

if (getChromeVersion() > 69 && ((chrome.clipboard || {}).onClipboardDataChanged || {}).addEventListener) {
  console.log('FINALLY USING NEW onClipboardDataChanged API!')
  // use new api https://developer.chrome.com/apps/clipboard
  chrome.clipboard.onClipboardDataChanged.addListener(copyclipper.pollClipboard)
} else {
  // Check the clipboard every second, if anything changed copyclip/filter it.
  copyclipper.intervalId = window.setInterval(copyclipper.pollClipboard, 1000)
}

copyclipper.notificationTimer = null

copyclipper.createNotification = function () {
  var desciption = '\n\nClipped from:\n'
  if (copyclipper.clipboardValueOriginal.length <
      copyclipper.clipboardValue.length) {
    desciption = '\n\nUnclipped from:\n'
  }
  const message = (copyclipper.clipboardValue + desciption + copyclipper.clipboardValueOriginal)
  const buttons = [{ title: 'Undo' }]
  copyclipper.showNotification(message, buttons)
}

copyclipper.showNotification = function (message, buttons) {
  copyclipper.clearNotifications()

  chrome.notifications.create('',
    {
      type: 'basic',
      title: 'Copyclipper',
      message: message,
      iconUrl: 'icon48.png',
      buttons: buttons
    },
    function (notificationId) {})

  if (copyclipper.notificationTimer != null) {
    clearTimeout(copyclipper.notificationTimer)
  }
  copyclipper.notificationTimer = setTimeout(copyclipper.clearNotifications,
    copyclipper.NOTIFICATION_TIMEOUT)
}

copyclipper.clearNotifications = function () {
  chrome.notifications.getAll(function (notificationIds) {
    for (var notificationId in notificationIds) {
      chrome.notifications.clear(notificationId, function (wasCleared) {})
    }
  })
}

copyclipper.notificationButtonClicked = function (notificationId, buttonIndex) {
  var orig = copyclipper.clipboardValueOriginal
  copyclipper.clipboardValueOriginal = copyclipper.clipboardValue
  copyclipper.setClipboardContents(orig)
  copyclipper.createNotification()
}

copyclipper.remoteSetClipboard = function (newValue, from) {
  copyclipper.clipboardValueOriginal = copyclipper.clipboardValue = newValue
  copyclipper.setClipboardContents(newValue)
  let message = 'Received clipboard'
  if (from) {
    message = message + ' from ' + from
  }
  copyclipper.showNotification(message, [])
}

// handlers for notification clicks
chrome.notifications.onButtonClicked.addListener(
  copyclipper.notificationButtonClicked)

chrome.storage.onChanged.addListener(function (changed, area) {
  if (area === 'sync' && changed.regexes) {
    console.log('regexes changed')
    copyclipper.restoreRegexes()
  }
})