summaryrefslogtreecommitdiffstats
path: root/server/lib/external-backends/backends/idoit-backend.js
blob: 74a59fe008a9865eb3a54ec0039b78b784937509 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
/* global __appdir */
const path = require('path')
const ExternalBackends = require(path.join(__appdir, 'lib', 'external-backends'))
var axios = require('axios')

class IdoitBackend extends ExternalBackends {
  /*
   * Returns the credential structure / fields, defined in the backends.
   */
  getCredentials () {
    return [
      { type: 'text', id: 1, name: 'API URL', icon: 'link' },
      { type: 'password', id: 2, name: 'API Token', icon: 'vpn_key', show: false },
      {
        type: 'switch',
        id: 3,
        name: 'Login',
        icon: 'lock_open',
        elements: [
          { type: 'text', id: 4, name: 'Username', icon: 'person_outline' },
          { type: 'password', id: 5, name: 'Password', icon: 'lock', show: false }
        ]
      }
    ]
  }

  /*
   * Checks the connection of a given backend.
   * idoIT: Checks if we can get a valid session id. If so the connection must be successfull.
   *
   * return: true / { error: <ERROR>, message: <MESSAGE> }
   */
  async checkConnection (credentials) {
    const c = this.mapCredentials(credentials)
    const body = this.getBody('idoit.version', { 'apikey': c.apikey }, 'version_check')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    // Axios request
    const result = await this.axiosRequest(c.url, [body], headers)
    if (result.error) return { error: 'IDOIT_ERROR', message: result.errno }
    return true
  }

  // Return the list of object types created in iDoIT.
  async getObjectTypes (credentials) {
    const c = this.mapCredentials(credentials)
    const body = this.getBody('cmdb.object_types', { 'apikey': c.apikey }, 'object_types')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    var result = {}
    result.types = await this.axiosRequest(c.url, [body], headers)
    result.types = result.types[0].result

    var types = []
    result.types.forEach(type => {
      types.push({ id: type.id, title: type.title })
    })

    return types
  }

  getSyncTypes () {
    return ['None', 'Two-Way', 'Upload Only', 'Upload Then Delete', 'Upload Mirror', 'Download Only', 'Download Then Delete', 'Download Mirror']
  }

  /*
   * Gets all objects and searches for the uuid to get the requested client.
   *
   */
  async getClient (credentials, client) {
    const c = this.mapCredentials(credentials)

    const paramsObjects = {
      'apikey': c.apikey,
      'filter': {
        'type': 10
      },
      'categories': ['C__CATG__MODEL']
    }
    const body = this.getBody('cmdb.objects', paramsObjects, 'objects')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    // Get all client objects.
    const clients = await this.axiosRequest(c.url, [body], headers)

    let result = clients[0].result.filter(x => x.categories.C__CATG__MODEL.length > 0 && x.categories.C__CATG__MODEL[0].productid === client.uuid)
    return result.length >= 1 ? result.map(x => x.id) : { error: 'NO_CLIENT_FOUND', msg: 'There is no client matching with the provided uuid.' }
  }

  async getObjects (credentials) {
    const c = this.mapCredentials(credentials)
    const body = this.getBody('cmdb.objects', { 'apikey': c.apikey }, 'objects')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    const objects = await this.axiosRequest(c.url, [body], headers)
    return objects[0]
  }

  async getObject (credentials, oid) {
    const c = this.mapCredentials(credentials)
    const body = this.getBody('cmdb.object.read', { 'apikey': c.apikey, 'id': oid }, 'object_read')
    const bodyChilds = this.getBody('cmdb.location_tree', { 'apikey': c.apikey, 'id': oid }, 'object_location_tree')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    var result = {}
    result.object = await this.axiosRequest(c.url, [body], headers)
    result.childs = await this.axiosRequest(c.url, [bodyChilds], headers)
    result.object = result.object[0].result
    result.childs = result.childs[0].result
    return result
  }

  async deleteObjects (credentials, objectIds) {
    const c = this.mapCredentials(credentials)
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    let bodies = []
    objectIds.forEach(oid => {
      bodies.push(this.getBody('cmdb.object.quickpurge', { 'id': oid, 'apikey': c.apikey }, oid))
    })

    let deleteRequest = await this.axiosRequest(c.url, bodies, headers)
    return deleteRequest
  }

  // Function to use the same session for multiple requests
  async getDataTree (credentials, objects) {
    const c = this.mapCredentials(credentials)
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    let bodies = []
    let gids = {}
    // Prepare all the batch request bodies.
    for (let element of objects) {
      bodies.push(this.getBody('cmdb.location_tree', { 'id': element.eid, 'apikey': c.apikey }, element.eid))
      gids[element.eid] = element.gid
    }

    // Send all the batch request and post proccess the result into one array.
    let requestResult = await this.axiosRequest(c.url, bodies, headers)

    // Post process the data.
    let result = []
    for (let res of requestResult) {
      result.push({ gid: gids[res.id], childs: res.result })
    }
    return result
  }

  /*
   * Adds the client to the backend.
   *
   * credentials: <BACKEND_CREDENTIALS>
   * The client parameters are all optional.
   * client: {
   *            title: <CLIENT_TITLE>, parentId: <PARENT_ID>,
   *            network: { mac: <MAC_ADDRESS>, ip: <IP_ADDRESS> }
   *         }
   */
  async addClient (credentials, client) {
    const c = this.mapCredentials(credentials)
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    let params = {
      'apikey': c.apikey,
      'title': client.title,
      'purpose': client.purpose === 'Pool PC' ? 7 : undefined,
      'categories': {}
    }

    if (client.type === 'CLIENT') params['type'] = 10
    else if (client.type === 'SERVER') {
      params['type'] = 5

      if (client.location) params.categories.C__CATG__LOCATION = { 'data': { 'parent': client.parentId, 'option': client.location.assembly, 'insertion': client.location.insertion, 'pos': client.location.pos } }
      if (client.formfactor) params.categories.C__CATG__FORMFACTOR = { 'data': { 'formfactor': client.formfactor, 'rackunits': client.formfactor.rackunits } }
      // TODO: Assign to rack with the given rackid
    } else if (client.parentId) params.categories.C__CATG__LOCATION = { 'data': { 'parent': client.parentId } }

    // Add categories to the object
    if (client.uuid) params.categories.C__CATG__MODEL = { 'data': { 'productid': client.uuid } }
    if (client.network) {
      // TOOD:
      // First read if there are current entries.
      // Delete the previous entries.
      // Finally create the new entry.
      if (client.network.mac) params.categories.C__CATG__NETWORK_PORT = { 'data': { 'category_id': 1, 'mac': client.network.mac } }
      if (client.network.ip) params.categories.C__CATG__IP = { 'data': { 'category_id': 1, 'ipv4_address': client.network.ip } }
    }

    // Send the create request.
    const body = this.getBody('cmdb.object.create', params, 'client_create')
    const requestCreate = await this.axiosRequest(c.url, [body], headers)

    // Error handling
    if (requestCreate.error) return { error: requestCreate.errno, message: 'Connection was refused.' }
    else if (requestCreate[0].error) return { error: 'IDOIT_ERROR', message: requestCreate[0].error.message }
    // Purpose for Clients:
    // 1 = Production         |  5 = PVS
    // 2 = Test               |  7 = Pool PC
    // 3 = Quality Assurance  |  8 = Mitarbeiter Arbeitsplatz
    return { succes: true, id: requestCreate[0].result.id, type: params.type, message: requestCreate[0].result.message }
  }

  /*
   * Updates the client information in the backend.
   *
   * credentials: <BACKEND_CREDENTIALS>
   * The client parameters are all optional.
   * client: {
   *            id: <CLIENT_ID>, title: <CLIENT_TITLE>, parentId: <PARENT_ID>,
   *            system: { model: <SYSTEM_MODEL>, manufacturer: <SYSTEM_MANUFACTURER>,  serialnumber: <SYSTEM_SERIALNUMBER> },
   *            cpu: { model: <CPU_MODEL>, manufacturer: <CPU_MANUFACTURER>, type: <CPU_TYPE>, frequency: <CPU_FREQUENCY>, cores: <CPU_CORES> },
   *            ram: [{ title: <RAM_TITLE>, manufacturer: <RAM_MANUFACTURER>, type: <RAM_TYPE>,  capacity: <RAM_CAPACITY>, unit: <RAM_UNIT> }, ...],
   *            drives: [{model: <DRIVE_MODEL>,}, serial: <DRIVE_SERIAL>, capacity: <DRIVE_CAPACITY>, unit: <DRIVE_UNIT>, type: <DRIVE_TYPE>, formfactor: <DRIVE_FORMFACTOR>, connection: <DRIVE_CONNECTION> ...]
   *         }
   */
  async updateClient (credentials, client) {
    const c = this.mapCredentials(credentials)
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    let bodies = []

    // Update title of the object
    if (client.title) bodies.push(this.getBody('cmdb.object.update', { 'id': client.id, 'title': client.title, 'apikey': c.apikey }, 'update_title'))

    // 'object' should be 'objID' but there is a fucking bug in the idoit api. Soo let's add both parameters because else it will break when they fix it.
    // Update the productid to the uuid.
    if (client.uuid) {
      let params = {
        'object': client.id,
        'objID': client.id,
        'category': 'C__CATG__MODEL',
        'data': {
          'productid': client.uuid
        },
        'apikey': c.apikey
      }
      bodies.push(this.getBody('cmdb.category.save', params, 'update_uuid'))
    }

    // Update the object. Location
    if (client.parentId) {
      let params = {
        'object': client.id,
        'objID': client.id,
        'category': 'C__CATG__LOCATION',
        'data': {
          'parent': client.parentId
        },
        'apikey': c.apikey
      }
      bodies.push(this.getBody('cmdb.category.save', params, 'update_parent'))
    }

    // Update the object. Model data.
    if (client.system) {
      let params = {
        'object': client.id,
        'objID': client.id,
        'category': 'C__CATG__MODEL',
        'data': {
          'manufacturer': client.system.manufacturer,
          'title': client.system.model,
          'serial': client.system.serialnumber
        },
        'apikey': c.apikey
      }
      bodies.push(this.getBody('cmdb.category.save', params, 'update_model'))
    }

    // Update the object. CPU data.
    // TODO: Delete cpu if exists?
    if (client.cpu) {
      let params = {
        'object': client.id,
        'objID': client.id,
        'category': 'C__CATG__CPU',
        'data': {
          'category_id': 1,
          'manufacturer': client.cpu.manufacturer,
          'title': client.cpu.model,
          'type': client.cpu.type,
          'frequency': client.cpu.frequency,
          'frequency_unit': 3,
          'cores': client.cpu.cores
        },
        'apikey': c.apikey
      }
      bodies.push(this.getBody('cmdb.category.save', params, 'update_cpu'))
    }

    // Update the object. Ram data.
    if (client.ram) {
      let counter = 1
      for (var memory in client.ram) {
        var mem = client.ram[memory]
        var ramId = 'create_memory_' + counter
        if (mem.unit === 'MB') mem.capacity = mem.capacity / 1024

        // 2 = MB
        // 3 = GB
        let params = {
          'object': client.id,
          'objID': client.id,
          'category': 'C__CATG__MEMORY',
          'data': {
            'title': mem.title,
            'manufacturer': mem.manufacturer,
            'type': mem.type,
            'capacity': mem.capacity,
            'unit': 3
          },
          'apikey': c.apikey
        }
        counter++
        bodies.push(this.getBody('cmdb.category.save', params, ramId))
      }
    }

    // Update the object. Drive data.
    if (client.drives) {
      let counter = 1
      for (var drive in client.drives) {
        var d = client.drives[drive]
        var driveId = 'create_drive_' + counter

        // UNIT
        var unit = 0
        if (d.unit === 'GB') unit = 3
        else if (d.unit === 'TB') unit = 4
        else if (d.unit === 'MB') unit = 2
        else if (d.unit === 'KB') unit = 1
        else if (d.unit === 'B') unit = 0

        let params = {
          'object': client.id,
          'objID': client.id,
          'category': 'C__CATG__STORAGE_DEVICE',
          'data': {
            'title': d.model,
            'type': d.type,
            // 'manufacturer': ,
            // 'model': ,
            'capacity': d.capacity,
            'unit': unit,
            'serial': d.serial,
            'connected': d.connection
          },
          'apikey': c.apikey
        }
        bodies.push(this.getBody('cmdb.category.save', params, driveId))
      }
    }

    const requestUpdate = await this.axiosRequest(c.url, bodies, headers)
    // 10 is the idoit object id for clients.
    var result = {
      success: true,
      id: client.id,
      type: 10,
      response: requestUpdate
    }

    return result
  }

  async getFileList (credentials, externalId) {
    const c = this.mapCredentials(credentials)
    const body = this.getBody('cmdb.category.read', { 'objID': externalId, 'category': 'C__CATG__FILE', apikey: c.apikey }, 'filelist')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    const result = await this.axiosRequest(c.url, [body], headers)
    return result[0].result
  }

  async getFile (credentials, externalId, filename) {
    const c = this.mapCredentials(credentials)
    const body = this.getBody('cmdb.category.read', { 'objID': externalId, 'category': 'C__CATG__FILE', apikey: c.apikey }, 'filelist')
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    const files = await this.axiosRequest(c.url, [body], headers)
    let fileObjId = files[0].result.find(x => x.file.title === filename).file.id

    const body2 = this.getBody('cmdb.category.read', { 'objID': fileObjId, 'category': 'C__CMDB__SUBCAT__FILE_VERSIONS', apikey: c.apikey }, 'file')
    let result = await this.axiosRequest(c.url, [body2], headers)
    result = result[0].result[0]

    return { filename: result.file_title, value: result.file_content.value, md5: result.md5_hash }
  }

  async uploadFiles (credentials, externalId, files) {
    const c = this.mapCredentials(credentials)
    const headers = await this.getHeaders(c)
    if (headers.error) return headers

    let result = []
    for (var key in files) {
      const filename = files[key].name
      /* eslint-disable */
      const buffer = new Buffer.from(files[key].data)
      /* eslint-enable */

      // Create the fileObject where the file gets uplaoded to.
      const body = this.getBody('cmdb.object.create', { 'type': 29, 'title': files[key].name, 'apikey': c.apikey }, 'createFileObject_' + key)
      const fileObject = await this.axiosRequest(c.url, [body], headers)

      // Upload file to fileobject.
      const paramsUploadFile = {
        'object': fileObject[0].result.id, // <-- workaround for the idoit api bug (wrong mapping of objID)
        'objID': fileObject[0].result.id,
        'data': {
          'file_content': buffer.toString('base64'),
          'file_physical': filename,
          'file_title': filename,
          'version_description': key
        },
        'category': 'C__CMDB__SUBCAT__FILE_VERSIONS',
        'apikey': c.apikey
      }
      const bodyUploadFile = this.getBody('cmdb.category.save', paramsUploadFile, 'uploadFile_' + key)
      const uploadFile = await this.axiosRequest(c.url, [bodyUploadFile], headers)

      // Connect the file with the client (object).
      const paramsConnectFile = {
        'object': externalId,
        'objID': externalId,
        'data': {
          'file': fileObject[0].result.id
        },
        'category': 'C__CATG__FILE',
        'apikey': c.apikey }
      const bodyConnect = this.getBody('cmdb.category.save', paramsConnectFile, 'uploadFile_' + key)
      const connectFile = await this.axiosRequest(c.url, [bodyConnect], headers)

      result.push({ createObject: fileObject, uploadFile: uploadFile, connectObjectFile: connectFile })
    }
    return result
  }

  // Helper function, to map the array of credential objects into a single js object.
  mapCredentials (credentials) {
    const c = JSON.parse(credentials)
    const login = c.find(x => x.id === 3)
    var mapped = {
      url: c.find(x => x.id === 1).value,
      apikey: c.find(x => x.id === 2).value,
      login: login.value
    }

    if (mapped.login) {
      mapped.username = login.elements.find(x => x.id === 4).value
      mapped.password = login.elements.find(x => x.id === 5).value
    }
    return mapped
  }

  // Method for making the axios request and error handling.
  async axiosRequest (url, bodies, headers, batchRequestSize = 400) {
    let config = { timeout: 180000, headers: headers }

    // Split batchrequest in multiple request
    let batchRequests = []
    // For spliceing the array a while loop seems to be the most efficient:
    // https://ourcodeworld.com/articles/read/278/how-to-split-an-array-into-chunks-of-the-same-size-easily-in-javascript
    while (bodies.length) {
      batchRequests = [...batchRequests, bodies.splice(0, batchRequestSize)]
    }
    // Make all batch request and return the result of all.
    let results = []
    let requestCounter = 1

    for (let i = 0; i < batchRequests.length; i++) {
      // Axios error handling
      try {
        console.log(requestCounter + '/' + batchRequests.length + ' requests send')
        requestCounter++
        const responses = await axios.post(url, batchRequests[i], config)
        if (Array.isArray(responses.data)) results = [...results, ...responses.data]
        else results = [...results, responses.data]
      } catch (error) {
        let errorResponse = { error: true }
        if (error.response) {
          // The request was made and the server responded with a status code
          // that falls out of the range of 2xx
          errorResponse['data'] = error.response.data
          errorResponse['status'] = error.response.status
          errorResponse['headers'] = error.response.headers
        } else if (error.request) {
          // The request was made but no response was received
          // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
          // http.ClientRequest in node.js
          errorResponse['errno'] = error.errno
        } else {
          // Something happened in setting up the request that triggered an Error
          errorResponse['message'] = error.message
        }

        return errorResponse
      }
    }
    return results
  }

  // Body wrapper for the requests to remove duplicated code.
  getBody (method, params, id) {
    return {
      'version': '2.0',
      'method': method,
      'params': {
        ...params,
        'language': 'en'
      },
      'id': id
    }
  }

  // Returns the header. Sets the session id if needed.
  async getHeaders (credentials = {}) {
    let headers = { 'Content-Type': 'application/json' }

    // Get a session id for the header
    if (credentials.login && credentials.username && credentials.password) {
      const header = {
        ...headers,
        'X-RPC-Auth-Username': credentials.username,
        'X-RPC-Auth-Password': credentials.password
      }
      const sessionRequest = await this.axiosRequest(credentials.url, [this.getBody('idoit.login', { 'apikey': credentials.apikey, 'language': 'en' }, 'login')], header)
      // Axios errors
      if (sessionRequest.error) return sessionRequest
      // Idoit error
      if (sessionRequest[0].error) return { error: 'IDOIT_ERROR', message: sessionRequest[0].error.message }
      headers = { ...headers, 'X-RPC-Auth-Session': sessionRequest[0].result['session-id'] }
    }

    return headers
  }
}

module.exports = IdoitBackend