etherpad-lite/src/node/db/PadManager.js

/**
 * The Pad Manager is a Factory for pad Objects
 */

/*
 * 2011 Peter 'Pita' Martischka (Primary Technology Ltd)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS-IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

var customError = require("../utils/customError");
var Pad = require("../db/Pad").Pad;
var db = require("./DB");

/**
 * A cache of all loaded Pads.
 *
 * Provides "get" and "set" functions,
 * which should be used instead of indexing with brackets. These prepend a
 * colon to the key, to avoid conflicting with built-in Object methods or with
 * these functions themselves.
 *
 * If this is needed in other places, it would be wise to make this a prototype
 * that's defined somewhere more sensible.
 */
var globalPads = {
    get: function(name) { return this[':'+name]; },
    set: function(name, value) {
      this[':'+name] = value;
    },
    remove: function(name) {
      delete this[':'+name];
    }
};

/**
 * A cache of the list of all pads.
 *
 * Updated without db access as new pads are created/old ones removed.
 */
let padList = {
  list: new Set(),
  cachedList: undefined,
  initiated: false,
  init: async function() {
    let dbData = await db.findKeys("pad:*", "*:*:*");

    if (dbData != null) {
      this.initiated = true;

      for (let val of dbData) {
        this.addPad(val.replace(/^pad:/,""), false);
      }
    }

    return this;
  },
  load: async function() {
    if (!this.initiated) {
      return this.init();
    }

    return this;
  },
  /**
   * Returns all pads in alphabetical order as array.
   */
  getPads: async function() {
    await this.load();

    if (!this.cachedList) {
      this.cachedList = Array.from(this.list).sort();
    }

    return this.cachedList;
  },
  addPad: function(name) {
    if (!this.initiated) return;

    if (!this.list.has(name)) {
      this.list.add(name);
      this.cachedList = undefined;
    }
  },
  removePad: function(name) {
    if (!this.initiated) return;

    if (this.list.has(name)) {
      this.list.delete(name);
      this.cachedList = undefined;
    }
  }
};

// initialises the all-knowing data structure

/**
 * Returns a Pad Object with the callback
 * @param id A String with the id of the pad
 * @param {Function} callback
 */
exports.getPad = async function(id, text)
{
  // check if this is a valid padId
  if (!exports.isValidPadId(id)) {
    throw new customError(id + " is not a valid padId", "apierror");
  }

  // check if this is a valid text
  if (text != null) {
    // check if text is a string
    if (typeof text != "string") {
      throw new customError("text is not a string", "apierror");
    }

    // check if text is less than 100k chars
    if (text.length > 100000) {
      throw new customError("text must be less than 100k chars", "apierror");
    }
  }

  let pad = globalPads.get(id);

  // return pad if it's already loaded
  if (pad != null) {
    return pad;
  }

  // try to load pad
  pad = new Pad(id);

  // initalize the pad
  await pad.init(text);
  globalPads.set(id, pad);
  padList.addPad(id);

  return pad;
}

exports.listAllPads = async function()
{
  let padIDs = await padList.getPads();

  return { padIDs };
}

// checks if a pad exists
exports.doesPadExist = async function(padId)
{
  let value = await db.get("pad:" + padId);

  return (value != null && value.atext);
}

// alias for backwards compatibility
exports.doesPadExists = exports.doesPadExist;

/**
 * An array of padId transformations. These represent changes in pad name policy over
 * time, and allow us to "play back" these changes so legacy padIds can be found.
 */
const padIdTransforms = [
  [/\s+/g, '_'],
  [/:+/g, '_']
];

// returns a sanitized padId, respecting legacy pad id formats
exports.sanitizePadId = async function sanitizePadId(padId) {
  for (let i = 0, n = padIdTransforms.length; i < n; ++i) {
    let exists = await exports.doesPadExist(padId);

    if (exists) {
      return padId;
    }

    let [from, to] = padIdTransforms[i];

    padId = padId.replace(from, to);
  }

  // we're out of possible transformations, so just return it
  return padId;
}

exports.isValidPadId = function(padId)
{
  return /^(g.[a-zA-Z0-9]{16}\$)?[^$]{1,50}$/.test(padId);
}

/**
 * Removes the pad from database and unloads it.
 */
exports.removePad = async (padId) => {
  const p = db.remove('pad:' + padId);
  exports.unloadPad(padId);
  padList.removePad(padId);
  await p;
}

// removes a pad from the cache
exports.unloadPad = function(padId)
{
  globalPads.remove(padId);
}