ipfs-bch-wallet-consumer/src/controllers/rest-api/ipfs/controller.js

/*
  REST API Controller library for the /ipfs route
*/

// Global npm libraries
import mime from 'mime-types'

// Local libraries
import wlogger from '../../../adapters/wlogger.js'

class IpfsRESTControllerLib {
  constructor (localConfig = {}) {
    // Dependency Injection.
    this.adapters = localConfig.adapters
    if (!this.adapters) {
      throw new Error(
        'Instance of Adapters library required when instantiating /ipfs REST Controller.'
      )
    }
    this.useCases = localConfig.useCases
    if (!this.useCases) {
      throw new Error(
        'Instance of Use Cases library required when instantiating /ipfs REST Controller.'
      )
    }

    // Encapsulate dependencies
    // this.UserModel = this.adapters.localdb.Users
    // this.userUseCases = this.useCases.user

    // Bind 'this' object to all subfunctions
    this.getStatus = this.getStatus.bind(this)
    this.getPeers = this.getPeers.bind(this)
    this.getRelays = this.getRelays.bind(this)
    this.handleError = this.handleError.bind(this)
    this.connect = this.connect.bind(this)
    this.getThisNode = this.getThisNode.bind(this)
    this.viewFile = this.viewFile.bind(this)
    this.getService = this.getService.bind(this)
    this.getFileInfo = this.getFileInfo.bind(this)
    this.getPins = this.getPins.bind(this)
  }

  /**
   * @api {get} /ipfs Get status on IPFS infrastructure
   * @apiPermission public
   * @apiName GetIpfsStatus
   * @apiGroup REST IPFS
   *
   * @apiExample Example usage:
   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs
   *
   */
  async getStatus (ctx) {
    try {
      const status = await this.adapters.ipfs.getStatus()

      ctx.body = { status }
    } catch (err) {
      wlogger.error('Error in ipfs/controller.js/getStatus(): ')
      // ctx.throw(422, err.message)
      this.handleError(ctx, err)
    }
  }

  // Return information on IPFS peers this node is connected to.
  async getPeers (ctx) {
    try {
      const showAll = ctx.request.body.showAll

      const peers = await this.adapters.ipfs.getPeers(showAll)

      ctx.body = { peers }
    } catch (err) {
      wlogger.error('Error in ipfs/controller.js/getPeers(): ')
      // ctx.throw(422, err.message)
      this.handleError(ctx, err)
    }
  }

  // Get data about the known Circuit Relays. Hydrate with data from peers list.
  async getRelays (ctx) {
    try {
      const relays = await this.adapters.ipfs.getRelays()

      ctx.body = { relays }
    } catch (err) {
      wlogger.error('Error in ipfs/controller.js/getRelays(): ')
      // ctx.throw(422, err.message)
      this.handleError(ctx, err)
    }
  }

  async connect (ctx) {
    try {
      const multiaddr = ctx.request.body.multiaddr
      const getDetails = ctx.request.body.getDetails

      // console.log('this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs: ', this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs)
      const result = await this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs.connectToPeer({ multiaddr, getDetails })
      // console.log('result: ', result)

      ctx.body = result
    } catch (err) {
      wlogger.error('Error in ipfs/controller.js/connect():', err)
      // ctx.throw(422, err.message)
      this.handleError(ctx, err)
    }
  }

  /**
   * @api {get} /ipfs/node Get a copy of the thisNode object from helia-coord
   * @apiPermission public
   * @apiName GetThisNode
   * @apiGroup REST IPFS
   *
   * @apiExample Example usage:
   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs/node
   *
   */
  async getThisNode (ctx) {
    try {
      const thisNode = this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode

      ctx.body = { thisNode }
    } catch (err) {
      wlogger.error('Error in ipfs/controller.js/getThisNode(): ')
      // ctx.throw(422, err.message)
      this.handleError(ctx, err)
    }
  }

  /**
   * @api {get} /ipfs/view/:cid Retrieve and display a file via its IPFS CID
   * @apiPermission public
   * @apiName GetCidView
   * @apiGroup REST IPFS
   *
   * @apiExample Example usage:
   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs/view/bafkreieaqtdhfywyddomswogynzymukosqqgqo7lkt5lch2zwfnc55m6om
   *
   */
  async viewFile (ctx) {
    try {
      const { cid } = ctx.params

      // const file = await this.adapters.ipfs.ipfs.blockstore.get(cid)
      // return file

      // const cid = ctx.params.cid

      const { filename, readStream } = await this.useCases.ipfs.downloadCid({ cid })

      // ctx.body = ctx.req.pipe(readStream)

      // Lookup the mime type from the filename.
      const contentType = mime.lookup(filename)

      ctx.set('Content-Type', contentType)
      ctx.set(
        'Content-Disposition',
        // 'inline; filename="' + filename + '"'
        `inline; filename="${filename}"`
      )
      ctx.body = readStream
    } catch (err) {
      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/viewFile(): ', err)
      this.handleError(ctx, err)
    }
  }

  /**
   * @api {get} /ipfs/service Get the IPFS ID for the File Pin service
   * @apiPermission public
   * @apiName GetService
   * @apiGroup REST IPFS
   * @apiDescription Get the IPFS ID for the ipfs-file-pin-service node that
   * this app is using to retrieve file data from.
   *
   * @apiExample Example usage:
   * curl -H "Content-Type: application/json" -X GET localhost:5015/ipfs/service
   *
   */
  async getService (ctx) {
    try {
      const selectedIpfsFileProvider = this.adapters.ipfs.ipfsCoordAdapter.state.selectedIpfsFileProvider

      ctx.body = {
        success: true,
        selectedIpfsFileProvider
      }
    } catch (err) {
      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/getService(): ', err)
      this.handleError(ctx, err)
    }
  }

  /**
   * @api {get} /ipfs/file-info/:cid Get file pin info about a CID
   * @apiPermission public
   * @apiName GetFileInfo
   * @apiGroup REST IPFS
   * @apiDescription Get file metadata and pin status information give a CID.
   *
   * @apiExample Example usage:
   * curl -H "Content-Type: application/json" -X GET localhost:5015/ipfs/file-info/bafkreieaqtdhfywyddomswogynzymukosqqgqo7lkt5lch2zwfnc55m6om
   *
   */
  async getFileInfo (ctx) {
    try {
      const { cid } = ctx.params

      const ipfsFiles = this.adapters.ipfsFiles

      const metadata = await ipfsFiles.getFileMetadata({ cid })
      console.log('getCidMetadata() metadata: ', metadata)

      ctx.body = metadata
    } catch (err) {
      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/getService(): ', err)
      this.handleError(ctx, err)
    }
  }

  /**
   * @api {get} /ipfs/pins Get info on latest 20 pinned files
   * @apiPermission public
   * @apiName GetPins
   * @apiGroup REST IPFS
   * @apiDescription Returns an array of the latest 20 pinned files.
   *
   * @apiExample Example usage:
   * curl -H "Content-Type: application/json" -X GET localhost:5015/ipfs/pins
   *
   */
  async getPins (ctx) {
    try {
      // const { cid } = ctx.params

      const ipfsFiles = this.adapters.ipfsFiles

      const pinData = await ipfsFiles.getPins()
      console.log('getPins() pinData: ', pinData)

      ctx.body = pinData
    } catch (err) {
      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/getPins(): ', err)
      this.handleError(ctx, err)
    }
  }

  // DRY error handler
  handleError (ctx, err) {
    // If an HTTP status is specified by the buisiness logic, use that.
    if (err.status) {
      if (err.message) {
        ctx.throw(err.status, err.message)
      } else {
        ctx.throw(err.status)
      }
    } else {
      // By default use a 422 error if the HTTP status is not specified.
      ctx.throw(422, err.message)
    }
  }
}

// module.exports = IpfsRESTControllerLib
export default IpfsRESTControllerLib