531 lines
19 KiB
CoffeeScript
531 lines
19 KiB
CoffeeScript
config = require './config'
|
|
common = require './common'
|
|
util = require 'util'
|
|
http = require 'http'
|
|
https = require 'https'
|
|
soap = require './soap'
|
|
tasks = require './tasks'
|
|
normalize = require('./normalize').normalize
|
|
db = require './db'
|
|
presets = require './presets'
|
|
mongodb = require 'mongodb'
|
|
fs = require 'fs'
|
|
apiFunctions = require './api-functions'
|
|
customCommands = require './custom-commands'
|
|
crypto = require 'crypto'
|
|
parameters = require './parameters'
|
|
|
|
OBJECT_REGEX = /\.$/
|
|
INSTANCE_REGEX = /\.[\d]+\.$/
|
|
|
|
|
|
# Used to reject new TR-069 sessions when under load
|
|
holdUntil = Date.now()
|
|
|
|
|
|
writeResponse = (currentRequest, res) ->
|
|
if res.headers['Content-Length'] == 0
|
|
# no more requests. terminate TCP connection
|
|
res.headers['Connection'] = 'close' if currentRequest.httpRequest.httpVersion == '1.1'
|
|
else
|
|
res.headers['Connection'] = 'Keep-Alive' if currentRequest.httpRequest.httpVersion == '1.0'
|
|
|
|
if config.DEBUG_DEVICES[currentRequest.deviceId]
|
|
dump = "# RESPONSE #{new Date(Date.now())}\n" + JSON.stringify(res.headers) + "\n#{res.data}\n\n"
|
|
fs = require('fs').appendFile("debug/#{currentRequest.deviceId}.dump", dump, (err) ->
|
|
throw err if err
|
|
)
|
|
|
|
currentRequest.httpResponse.writeHead(res.code, res.headers)
|
|
currentRequest.httpResponse.end(res.data)
|
|
|
|
|
|
updateDevice = (currentRequest, actions, callback) ->
|
|
if not actions?
|
|
callback() if callback?
|
|
return
|
|
|
|
now = new Date(Date.now())
|
|
updates = {}
|
|
deletes = {}
|
|
|
|
if actions.parameterValues?
|
|
for p in actions.parameterValues
|
|
origValue = p[1]
|
|
v = normalize(p[0], origValue)
|
|
|
|
path = if common.endsWith(p[0], '.') then p[0] else "#{p[0]}."
|
|
if v == origValue
|
|
deletes["#{path}_orig"] = 1
|
|
else
|
|
updates["#{path}_orig"] = origValue
|
|
updates["#{path}_value"] = v
|
|
updates["#{path}_timestamp"] = now
|
|
if p[2]?
|
|
updates["#{path}_type"] = p[2]
|
|
else
|
|
deletes["#{path}_type"] = 1
|
|
|
|
if actions.deletedObjects?
|
|
for p in actions.deletedObjects
|
|
deletes[p] = 1
|
|
|
|
if actions.instanceName?
|
|
for i in actions.instanceName
|
|
updates["#{i[0]}._name"] = i[1]
|
|
|
|
if actions.parameterNames?
|
|
for p in actions.parameterNames
|
|
if OBJECT_REGEX.test(p[0])
|
|
path = p[0]
|
|
if INSTANCE_REGEX.test(p[0])
|
|
updates["#{path}_instance"] = true
|
|
else
|
|
updates["#{path}_object"] = true
|
|
else
|
|
path = "#{p[0]}."
|
|
updates["#{path}_writable"] = p[1] if p[1]?
|
|
updates["#{path}_timestamp"] = now
|
|
|
|
# Add parameter (sans any dot suffix) if has an alias
|
|
if (a = parameters.getAlias(pp = path.slice(0, -1)))?
|
|
newAliases = {} if not newAliases?
|
|
newAliases[pp] = a
|
|
|
|
if actions.customCommands?
|
|
for p in actions.customCommands
|
|
commandName = p[0]
|
|
updates["_customCommands.#{commandName}._value"] = p[1]
|
|
updates["_customCommands.#{commandName}._timestamp"] = now
|
|
|
|
if actions.set?
|
|
common.extend(updates, actions.set)
|
|
|
|
if Object.keys(updates).length > 0 or Object.keys(deletes).length > 0
|
|
db.devicesCollection.update({'_id' : currentRequest.deviceId}, {'$set' : updates, '$unset' : deletes}, {}, (err, count) ->
|
|
throw err if err
|
|
# Clear aliases cache if there's a new aliased parameter that has not been included in aliases cache
|
|
if newAliases?
|
|
db.getAliases((aliases) ->
|
|
for p, a of newAliases
|
|
if not aliases[a]? or p not in aliases[a]
|
|
db.redisClient.del('aliases', (err, res) ->
|
|
throw err if err
|
|
)
|
|
break
|
|
)
|
|
callback?(err)
|
|
)
|
|
else
|
|
callback?()
|
|
|
|
|
|
inform = (currentRequest, cwmpRequest) ->
|
|
# If overloaded, ask CPE to retry in 5 mins
|
|
if Date.now() < holdUntil
|
|
res = {code : 503, headers : {'Content-Length' : 0, 'Retry-After' : 300}, data : ''}
|
|
return writeResponse(currentRequest, res)
|
|
|
|
now = new Date(Date.now())
|
|
|
|
util.log("#{currentRequest.deviceId}: Inform (#{cwmpRequest.methodRequest.event}); retry count #{cwmpRequest.methodRequest.retryCount}") if config.LOG_INFORMS
|
|
|
|
parameterNames = (p[0] for p in cwmpRequest.methodRequest.parameterList)
|
|
|
|
informHash = crypto.createHash('md5').update(JSON.stringify(parameterNames)).update(JSON.stringify(config.CUSTOM_COMMANDS)).digest('hex')
|
|
|
|
actions = {parameterValues : cwmpRequest.methodRequest.parameterList, set : {}}
|
|
actions.set._lastInform = now
|
|
actions.set._lastBoot = now if '1 BOOT' in cwmpRequest.methodRequest.event
|
|
actions.set._lastBootstrap = lastBootstrap = now if '0 BOOTSTRAP' in cwmpRequest.methodRequest.event
|
|
|
|
db.redisClient.get("#{currentRequest.deviceId}_inform_hash", (err, res) ->
|
|
throw err if err
|
|
|
|
if not res?
|
|
db.redisClient.setex("#{currentRequest.deviceId}_inform_hash", config.PRESETS_CACHE_DURATION, informHash, (err, res) ->
|
|
throw err if err
|
|
)
|
|
|
|
updateAndRespond = () ->
|
|
updateDevice(currentRequest, actions, (err) ->
|
|
throw err if err
|
|
res = soap.response(cwmpRequest.id, {methodResponse : {type : 'InformResponse'}}, {deviceId : currentRequest.deviceId})
|
|
writeResponse(currentRequest, res)
|
|
)
|
|
|
|
if res == informHash
|
|
return updateAndRespond()
|
|
|
|
# populate projection and parameterStructure
|
|
parameterStructure = {}
|
|
projection = {}
|
|
projection._customCommands = 1
|
|
projection._timestamp = 1
|
|
projection._lastBootstrap = 1
|
|
for param in parameterNames
|
|
ref = parameterStructure
|
|
path = ''
|
|
for p in param.split('.')
|
|
ref[p] ?= {_path : path}
|
|
ref = ref[p]
|
|
path += p + '.'
|
|
projection[path + '_timestamp'] = 1
|
|
|
|
db.devicesCollection.findOne({'_id' : currentRequest.deviceId}, projection, (err, device) ->
|
|
throw err if err
|
|
lastBootstrap ?= device?._lastBootstrap
|
|
_tasks = []
|
|
|
|
# For any parameters that aren't in the DB model, issue a refresh task
|
|
traverse = (reference, actual) ->
|
|
for k of reference
|
|
continue if k[0] == '_'
|
|
if not actual[k]?._timestamp? or actual[k]._timestamp < lastBootstrap
|
|
_tasks.push({device: currentRequest.deviceId, name : 'refreshObject', objectName : reference[k]._path})
|
|
else
|
|
traverse(reference[k], actual[k])
|
|
|
|
if device?
|
|
traverse(parameterStructure, device)
|
|
|
|
# Update custom commands if needed
|
|
deviceCustomCommands = {}
|
|
deviceCustomCommands[k] = v._timestamp for k,v of device._customCommands
|
|
|
|
for cmd in customCommands.getDeviceCustomCommandNames(currentRequest.deviceId)
|
|
if not (deviceCustomCommands[cmd]?._timestamp < lastBootstrap)
|
|
_tasks.push({device: currentRequest.deviceId, name: 'customCommand', command: "#{cmd} init"})
|
|
delete deviceCustomCommands[cmd]
|
|
|
|
for cmd of deviceCustomCommands
|
|
actions.deletedObjects ?= []
|
|
actions.deletedObjects.push("_customCommands.#{cmd}")
|
|
|
|
apiFunctions.insertTasks(_tasks, {}, () ->
|
|
updateAndRespond()
|
|
)
|
|
else
|
|
deviceIdDetails = {}
|
|
for k, v of cwmpRequest.methodRequest.deviceId
|
|
deviceIdDetails["_#{k}"] = v
|
|
|
|
db.devicesCollection.insert({_id : currentRequest.deviceId, _registered : now, _deviceId : deviceIdDetails}, (err) ->
|
|
throw err if err
|
|
util.log("#{currentRequest.deviceId}: New device registered")
|
|
_tasks.push({device: currentRequest.deviceId, name : 'refreshObject', objectName : ''})
|
|
|
|
for cmd in customCommands.getDeviceCustomCommandNames(currentRequest.deviceId)
|
|
_tasks.push({device: currentRequest.deviceId, name: 'customCommand', command: "#{cmd} init"})
|
|
|
|
apiFunctions.insertTasks(_tasks, {}, () ->
|
|
updateAndRespond()
|
|
)
|
|
)
|
|
)
|
|
)
|
|
|
|
|
|
runTask = (currentRequest, task, methodResponse) ->
|
|
timeDiff = process.hrtime()
|
|
tasks.task(task, methodResponse, (err, status, cwmpResponse, deviceUpdates) ->
|
|
throw err if err
|
|
# TODO handle error
|
|
updateDevice(currentRequest, deviceUpdates, (err) ->
|
|
throw err if err
|
|
|
|
timeDiff = process.hrtime(timeDiff)[0] + 1
|
|
if timeDiff > 3 # in seconds
|
|
# Server under load. Hold new sessions temporarily.
|
|
holdUntil = Math.max(Date.now() + timeDiff * 2000, holdUntil)
|
|
|
|
save = status & tasks.STATUS_SAVE
|
|
switch status & ~tasks.STATUS_SAVE
|
|
when tasks.STATUS_OK
|
|
f = () ->
|
|
db.redisClient.setex(String(task._id), config.CACHE_DURATION, JSON.stringify(task), (err) ->
|
|
throw err if err
|
|
res = soap.response(task._id, cwmpResponse)
|
|
writeResponse(currentRequest, res)
|
|
)
|
|
|
|
if save
|
|
db.tasksCollection.update({_id : mongodb.ObjectID(String(task._id))}, {$set : {session : task.session}}, (err) ->
|
|
throw err if err
|
|
f()
|
|
)
|
|
else
|
|
f()
|
|
when tasks.STATUS_COMPLETED
|
|
util.log("#{currentRequest.deviceId}: Completed task #{task.name}(#{task._id})")
|
|
db.tasksCollection.remove({'_id' : mongodb.ObjectID(String(task._id))}, (err, removed) ->
|
|
throw err if err
|
|
db.redisClient.del(String(task._id), (err, res) ->
|
|
throw err if err
|
|
nextTask(currentRequest)
|
|
)
|
|
)
|
|
when tasks.STATUS_FAULT
|
|
retryAfter = config.RETRY_DELAY * Math.pow(2, task.retries ? 0)
|
|
util.log("#{currentRequest.deviceId}: Fault response for task #{task._id}. Retrying after #{retryAfter} seconds.")
|
|
taskUpdate = {fault : task.fault, timestamp : new Date(Date.now() + retryAfter * 1000)}
|
|
if save
|
|
taskUpdate.session = task.session
|
|
|
|
db.tasksCollection.update({_id : mongodb.ObjectID(String(task._id))}, {$set : taskUpdate, $inc : {retries : 1}}, (err) ->
|
|
throw err if err
|
|
nextTask(currentRequest)
|
|
)
|
|
else
|
|
throw new Error('Unknown task status')
|
|
)
|
|
)
|
|
|
|
|
|
isTaskExpired = (task) ->
|
|
task.expiry <= new Date()
|
|
|
|
|
|
assertPresets = (currentRequest) ->
|
|
db.redisClient.mget("#{currentRequest.deviceId}_presets_hash", 'presets_hash', (err, res) ->
|
|
throw err if err
|
|
devicePresetsHash = res[0]
|
|
presetsHash = res[1]
|
|
if devicePresetsHash? and devicePresetsHash == presetsHash
|
|
# no discrepancy, return empty response
|
|
res = soap.response(null, {})
|
|
writeResponse(currentRequest, res)
|
|
else
|
|
db.getPresetsObjectsAliases((allPresets, allObjects, allAliases) ->
|
|
if not presetsHash?
|
|
presetsHash = presets.calculatePresetsHash(allPresets, allObjects)
|
|
db.redisClient.setex('presets_hash', config.PRESETS_CACHE_DURATION, presetsHash, (err, res) ->
|
|
throw err if err
|
|
)
|
|
|
|
presets.getDevicePreset(currentRequest.deviceId, allPresets, allObjects, allAliases, (devicePreset) ->
|
|
presets.processDevicePreset(currentRequest.deviceId, devicePreset, (taskList, addTags, deleteTags, expiry) ->
|
|
db.redisClient.setex("#{currentRequest.deviceId}_presets_hash", Math.floor(Math.max(1, expiry - config.PRESETS_TIME_PADDING)), presetsHash, (err, res) ->
|
|
throw err if err
|
|
)
|
|
|
|
if addTags.length + deleteTags.length + taskList.length
|
|
util.log("#{currentRequest.deviceId}: Presets discrepancy found")
|
|
|
|
if addTags.length + deleteTags.length
|
|
util.log("#{currentRequest.deviceId}: Updating tags +(#{addTags}) -(#{deleteTags})")
|
|
|
|
if deleteTags.length
|
|
db.devicesCollection.update({'_id' : currentRequest.deviceId}, {'$pull' : {'_tags' : {'$in' : deleteTags}}}, {}, (err, count) ->
|
|
throw err if err
|
|
)
|
|
|
|
if addTags.length
|
|
db.devicesCollection.update({'_id' : currentRequest.deviceId}, {'$addToSet' : {'_tags' : {'$each' : addTags}}}, {}, (err, count) ->
|
|
throw err if err
|
|
)
|
|
|
|
if taskList.length
|
|
t.expiry = expiry for t in taskList
|
|
apiFunctions.insertTasks(taskList, allAliases, (err, taskList) ->
|
|
throw err if err
|
|
task = taskList[0]
|
|
util.log("#{currentRequest.deviceId}: Started task #{task.name}(#{task._id})")
|
|
runTask(currentRequest, task, {})
|
|
)
|
|
else
|
|
res = soap.response(null, {}, {})
|
|
writeResponse(currentRequest, res)
|
|
)
|
|
)
|
|
)
|
|
)
|
|
|
|
|
|
nextTask = (currentRequest) ->
|
|
now = new Date()
|
|
cur = db.tasksCollection.find({'device' : currentRequest.deviceId, timestamp : {$lte : now}}).sort(['timestamp']).limit(1)
|
|
cur.nextObject((err, task) ->
|
|
throw err if err
|
|
cwmpResponse = {}
|
|
|
|
if not task
|
|
# no more tasks, check presets discrepancy
|
|
assertPresets(currentRequest)
|
|
else if isTaskExpired(task)
|
|
util.log("#{currentRequest.deviceId}: Task is expired #{task.name}(#{task._id})")
|
|
db.tasksCollection.remove({'_id' : mongodb.ObjectID(String(task._id))}, {safe: true}, (err, removed) ->
|
|
throw err if err
|
|
nextTask(currentRequest)
|
|
)
|
|
else
|
|
util.log("#{currentRequest.deviceId}: Started task #{task.name}(#{task._id})")
|
|
runTask(currentRequest, task, {})
|
|
)
|
|
|
|
|
|
listener = (httpRequest, httpResponse) ->
|
|
if httpRequest.method != 'POST'
|
|
httpResponse.writeHead 405, {'Allow': 'POST'}
|
|
httpResponse.end('405 Method Not Allowed')
|
|
return
|
|
|
|
chunks = []
|
|
bytes = 0
|
|
cookies = {}
|
|
|
|
httpRequest.addListener 'data', (chunk) ->
|
|
chunks.push(chunk)
|
|
bytes += chunk.length
|
|
|
|
httpRequest.getBody = (encoding) ->
|
|
# Write all chunks into a Buffer
|
|
body = new Buffer(bytes)
|
|
offset = 0
|
|
chunks.forEach((chunk) ->
|
|
chunk.copy(body, offset, 0, chunk.length)
|
|
offset += chunk.length
|
|
)
|
|
|
|
#Return encoded (default to UTF8) string
|
|
return body.toString(encoding || 'utf8', 0, body.byteLength)
|
|
|
|
httpRequest.addListener 'end', () ->
|
|
cwmpResponse = {}
|
|
cwmpRequest = soap.request(httpRequest)
|
|
|
|
currentRequest = {
|
|
httpRequest : httpRequest
|
|
httpResponse : httpResponse
|
|
}
|
|
|
|
if cwmpRequest.methodRequest?.deviceId?
|
|
currentRequest.deviceId = common.getDeviceId(cwmpRequest.methodRequest.deviceId)
|
|
else
|
|
currentRequest.deviceId = cwmpRequest.cookies.deviceId
|
|
|
|
if config.DEBUG_DEVICES[currentRequest.deviceId]
|
|
dump = "# REQUEST #{new Date(Date.now())}\n" + JSON.stringify(httpRequest.headers) + "\n#{httpRequest.getBody()}\n\n"
|
|
require('fs').appendFile("debug/#{currentRequest.deviceId}.dump", dump, (err) ->
|
|
throw err if err
|
|
)
|
|
|
|
if cwmpRequest.methodRequest?
|
|
if cwmpRequest.methodRequest.type is 'Inform'
|
|
inform(currentRequest, cwmpRequest)
|
|
else if cwmpRequest.methodRequest.type is 'TransferComplete'
|
|
# do nothing
|
|
util.log("#{currentRequest.deviceId}: Transfer complete")
|
|
cwmpResponse.methodResponse = {type : 'TransferCompleteResponse'}
|
|
res = soap.response(cwmpRequest.id, cwmpResponse, cookies)
|
|
writeResponse(currentRequest, res)
|
|
else if cwmpRequest.methodRequest.type is 'RequestDownload'
|
|
requestDownloadResponse = () ->
|
|
cwmpResponse.methodResponse = {type : 'RequestDownloadResponse'}
|
|
res = soap.response(cwmpRequest.id, cwmpResponse, cookies)
|
|
writeResponse(currentRequest, res)
|
|
fileType = cwmpRequest.methodRequest.fileType
|
|
util.log("#{currentRequest.deviceId}: RequestDownload (#{fileType})")
|
|
if fileType isnt '1 Firmware Upgrade Image'
|
|
# Only supporting firmware upgrade for now
|
|
return requestDownloadResponse()
|
|
|
|
db.getPresetsObjectsAliases((allPresets, allObjects, allAliases) ->
|
|
presets.getDevicePreset(currentRequest.deviceId, allPresets, allObjects, allAliases, (devicePreset) ->
|
|
presetSoftwareVersion = devicePreset.softwareVersion?.preset
|
|
currentSoftwareVersion = devicePreset.softwareVersion?.current._value
|
|
if presetSoftwareVersion? and presetSoftwareVersion != currentSoftwareVersion
|
|
projection = {
|
|
'_deviceId._Manufacturer' : 1,
|
|
'_deviceId._ProductClass' : 1,
|
|
}
|
|
db.devicesCollection.findOne({'_id' : currentRequest.deviceId}, projection, (err, device) ->
|
|
throw err if err
|
|
manufacturer = device._deviceId._Manufacturer
|
|
productClass = device._deviceId._ProductClass
|
|
db.filesCollection.findOne({'metadata.fileType' : '1 Firmware Upgrade Image', 'metadata.manufacturer' : manufacturer, 'metadata.productClass' : productClass, 'metadata.version' : presetSoftwareVersion}, {_id : 1}, (err, file) ->
|
|
throw err if err
|
|
if not file?
|
|
util.error("#{currentRequest.deviceId}: Firmware image not found (#{presetSoftwareVersion})")
|
|
return requestDownloadResponse()
|
|
|
|
task = {
|
|
device : currentRequest.deviceId,
|
|
name : 'download',
|
|
file : file['_id']
|
|
}
|
|
apiFunctions.insertTasks(task, allAliases, (err, tasks) ->
|
|
throw err if err
|
|
return requestDownloadResponse()
|
|
)
|
|
)
|
|
)
|
|
else
|
|
return requestDownloadResponse()
|
|
)
|
|
)
|
|
else
|
|
throw new Error('ACS method not supported')
|
|
else if cwmpRequest.methodResponse?
|
|
taskId = cwmpRequest.id
|
|
|
|
db.getTask(taskId, (err, task) ->
|
|
throw err if err
|
|
if not task
|
|
nextTask(currentRequest)
|
|
else
|
|
runTask(currentRequest, task, cwmpRequest.methodResponse)
|
|
)
|
|
else if cwmpRequest.fault?
|
|
taskId = cwmpRequest.id
|
|
if not taskId
|
|
# Fault not related to a task. return empty response.
|
|
res = soap.response(null, {}, {})
|
|
writeResponse(currentRequest, res)
|
|
return
|
|
|
|
db.getTask(taskId, (err, task) ->
|
|
throw err if err
|
|
if not task
|
|
nextTask(currentRequest)
|
|
else
|
|
runTask(currentRequest, task, cwmpRequest.fault)
|
|
)
|
|
else
|
|
# cpe sent empty response. start sending acs requests
|
|
nextTask(currentRequest)
|
|
|
|
|
|
cluster = require 'cluster'
|
|
numCPUs = require('os').cpus().length
|
|
|
|
if cluster.isMaster
|
|
db.redisClient.flushdb()
|
|
cluster.on('listening', (worker, address) ->
|
|
util.log("Worker #{worker.process.pid} listening to #{address.address}:#{address.port}")
|
|
)
|
|
|
|
cluster.on('exit', (worker, code, signal) ->
|
|
util.log("Worker #{worker.process.pid} died (#{worker.process.exitCode})")
|
|
setTimeout(()->
|
|
cluster.fork()
|
|
, config.WORKER_RESPAWN_TIME)
|
|
)
|
|
|
|
for [1 .. numCPUs]
|
|
cluster.fork()
|
|
else
|
|
options = {
|
|
key: fs.readFileSync('../config/httpscert.key'),
|
|
cert: fs.readFileSync('../config/httpscert.crt')
|
|
}
|
|
|
|
httpServer = http.createServer(listener)
|
|
httpsServer = https.createServer(options, listener)
|
|
|
|
# wait until DB connections are established
|
|
setTimeout(() ->
|
|
httpServer.listen(config.ACS_PORT, config.ACS_INTERFACE)
|
|
httpsServer.listen(config.ACS_HTTPS_PORT, config.ACS_HTTPS_INTERFACE)
|
|
, 1000)
|