smc-hub/dist/blobs.js

CoCalc: Backend webserver component

// Generated by CoffeeScript 2.5.1
(function() {
  //########################################################################
  // This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
  // License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
  //########################################################################

  // Blobs
  var MAX_BLOB_SIZE, MAX_BLOB_SIZE_HUMAN, defaults, misc, misc_node, required, winston;

  winston = require('./logger').getLogger('blobs');

  misc_node = require('smc-util-node/misc_node');

  misc = require('smc-util/misc');

  ({defaults, required} = misc);

  MAX_BLOB_SIZE = 15000000;

  MAX_BLOB_SIZE_HUMAN = "15MB";

  // save a blob in the blobstore database with given misc_node.uuidsha1 hash.
  exports.save_blob = function(opts) {
    var dbg, err;
    opts = defaults(opts, {
      uuid: void 0, // uuid=sha1-based from blob; actually *required*, but instead of a traceback, get opts.cb(err)
      blob: void 0, // actually *required*, but instead of a traceback, get opts.cb(err)
      ttl: void 0, // object in blobstore will have *at least* this ttl in seconds;
      // if there is already something, in blobstore with longer ttl, we leave it; undefined = infinite ttl
      check: true, // if true, return an error (via cb) if misc_node.uuidsha1(opts.blob) != opts.uuid.
      // This is a check against bad user-supplied data.
      project_id: void 0, // also required
      database: required,
      cb: required // cb(err, ttl actually used in seconds); ttl=0 for infinite ttl
    });
    dbg = function(m) {
      return winston.debug(`save_blob(uuid=${opts.uuid}): ${m}`);
    };
    dbg();
    err = void 0;
    if (opts.blob == null) {
      err = `save_blob: UG -- error in call to save_blob (uuid=${opts.uuid}); received a save_blob request with undefined blob`;
    } else if (opts.uuid == null) {
      err = "save_blob: BUG -- error in call to save_blob; received a save_blob request without corresponding uuid";
    } else if (opts.project_id == null) {
      err = "save_blob: BUG -- error in call to save_blob; received a save_blob request without corresponding project_id";
    } else if (opts.blob.length > MAX_BLOB_SIZE) {
      err = `save_blob: blobs are limited to ${MAX_BLOB_SIZE_HUMAN} and you just tried to save one of size ${opts.blob.length / 1000000}MB`;
    } else if (opts.check && opts.uuid !== misc_node.uuidsha1(opts.blob)) {
      err = `save_blob: uuid=${opts.uuid} must be derived from the Sha1 hash of blob, but it is not (possible malicious attack)`;
    }
    if (err) {
      dbg(err);
      opts.cb(err);
      return;
    }
    // Store the blob in the database, if it isn't there already.
    return opts.database.save_blob({
      uuid: opts.uuid,
      blob: opts.blob,
      ttl: opts.ttl,
      project_id: opts.project_id,
      cb: (err, ttl) => {
        if (err) {
          dbg(`failed to store blob -- ${err}`);
        } else {
          dbg("successfully stored blob");
        }
        return opts.cb(err, ttl);
      }
    });
  };

}).call(this);

//# sourceMappingURL=blobs.js.map