@elibrary-inno/bookreader/src/plugins/plugin.archive_analytics.js

The Internet Archive BookReader.

/* global BookReader */
/**
 * Plugin for Archive.org analytics
 */
jQuery.extend(BookReader.defaultOptions, {
  enableArchiveAnalytics: true,
  /** Provide a means of debugging, cause otherwise it's impossible to test locally */
  debugArchiveAnaltyics: false,
});

BookReader.prototype.init = (function(super_) {
  return function() {
    super_.call(this);

    if (this.options.enableArchiveAnalytics) {
      this.bind(BookReader.eventNames.fragmentChange, () => this.archiveAnalyticsSendFragmentChange());
    }
  };
})(BookReader.prototype.init);

/** @private */
BookReader.prototype.archiveAnalyticsSendFragmentChange = function() {
  if (!window.archive_analytics) {
    return;
  }

  const prevFragment = this.archiveAnalyticsSendFragmentChange.prevFragment;

  const params = this.paramsFromCurrent();
  const newFragment = this.fragmentFromParams(params);

  if (prevFragment != newFragment) {
    const values = {
      bookreader: "user_changed_view",
      itemid: this.bookId,
      cache_bust: Math.random()
    };
    // EEK!  offsite embedding and /details/ page books look the same in analytics, otherwise!
    values.offsite = 1;
    values.details = 0;
    try {
      values.offsite = window.top.location.hostname.match(/\.archive.org$/)
        ? 0
        : 1;
      values.details =
        !values.offsite && window.top.location.pathname.match(/^\/details\//)
          ? 1
          : 0;
    } catch (e) {}
    // avoids embed cross site exceptions -- but on (+) side, means it is and keeps marked offite!

    // Send bookreader ping
    window.archive_analytics.send_ping(values, null, "augment_for_ao_site");

    // Also send tracking event ping
    const additionalEventParams = this.options.lendingInfo && this.options.lendingInfo.loanId
      ? { loanId: this.options.lendingInfo.loanId }
      : {};
    window.archive_analytics.send_event('BookReader', 'UserChangedView', window.location.pathname, additionalEventParams);

    this.archiveAnalyticsSendFragmentChange.prevFragment = newFragment;
  }
};

/**
 * Sends a tracking "Event". See https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#events
 * @param {string} category
 * @param {string} action
 * @param {number} [value] (must be an int)
 * @param {Object} [additionalEventParams]
 */
BookReader.prototype.archiveAnalyticsSendEvent = function(category, action, value, additionalEventParams) {
  if (!this.options.enableArchiveAnalytics) return;

  if (this.options.debugArchiveAnaltyics) {
    console.log("archiveAnalyticsSendEvent", arguments, window.archive_analytics);
  }

  if (!window.archive_analytics) return;

  additionalEventParams = additionalEventParams || {};
  if (typeof(value) == 'number') {
    additionalEventParams.ev = value;
  }
  window.archive_analytics.send_event(category, action, null, additionalEventParams);
};