genieacs/lib/default-provisions.ts

/**
 * Copyright 2013-2018  Zaid Abdulla
 *
 * This file is part of GenieACS.
 *
 * GenieACS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * GenieACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with GenieACS.  If not, see <http://www.gnu.org/licenses/>.
 */

import * as config from "./config";
import * as common from "./common";
import * as device from "./device";
import * as scheduling from "./scheduling";

const MAX_DEPTH = +config.get("MAX_DEPTH");

export function refresh(sessionContext, provision, declarations): boolean {
  const path = common.parsePath(provision[1]).slice();
  const l = path.length;
  path.length = MAX_DEPTH;
  path.fill("*", l);
  const every = 1000 * (provision[2] || 1);
  const offset = scheduling.variance(sessionContext.deviceId, every);
  const t = scheduling.interval(sessionContext.timestamp, every, offset);

  for (let i = l; i < path.length; ++i) {
    declarations.push({
      path: path.slice(0, i),
      pathGet: t,
      pathSet: null,
      attrGet: { object: 1, writable: 1, value: t },
      attrSet: null,
      defer: true
    });
  }

  return true;
}

export function value(sessionContext, provision, declarations): boolean {
  const path = common.parsePath(provision[1]);
  declarations.push({
    path: path,
    pathGet: 1,
    pathSet: null,
    attrGet: { value: 1 },
    attrSet: { value: [provision[2]] },
    defer: true
  });

  return true;
}

export function tag(sessionContext, provision, declarations): boolean {
  const path = ["Tags", provision[1]];

  declarations.push({
    path: path,
    pathGet: 1,
    pathSet: null,
    attrGet: { value: 1 },
    attrSet: { value: [provision[2]] },
    defer: true
  });

  return true;
}

export function reboot(sessionContext, provision, declarations): boolean {
  declarations.push({
    path: ["Reboot"],
    pathGet: 1,
    pathSet: null,
    attrGet: { value: 1 },
    attrSet: { value: [sessionContext.timestamp] },
    defer: true
  });

  return true;
}

export function reset(sessionContext, provision, declarations): boolean {
  declarations.push({
    path: ["FactoryReset"],
    pathGet: 1,
    pathSet: null,
    attrGet: { value: 1 },
    attrSet: { value: [sessionContext.timestamp] },
    defer: true
  });

  return true;
}

export function download(sessionContext, provision, declarations): boolean {
  const alias = [
    ["FileType"],
    provision[1] || "",
    ["FileName"],
    provision[2] || "",
    ["TargetFileName"],
    provision[3] || ""
  ];

  declarations.push({
    path: ["Downloads", alias],
    pathGet: 1,
    pathSet: 1,
    attrGet: null,
    attrSet: null,
    defer: true
  });

  declarations.push({
    path: ["Downloads", alias, "Download"],
    pathGet: 1,
    pathSet: null,
    attrGet: { value: 1 },
    attrSet: { value: [sessionContext.timestamp] },
    defer: true
  });

  return true;
}

export function instances(
  sessionContext,
  provision,
  declarations,
  startRevision,
  endRevision
): boolean {
  let count = Number(provision[2]);

  if (Number.isNaN(count)) return true;

  const path = common.parsePath(provision[1]);

  if (provision[2][0] === "+" || provision[2][0] === "-") {
    declarations.push({
      path: path,
      pathGet: 1,
      pathSet: null,
      attrGet: null,
      attrSet: null,
      defer: true
    });

    if (endRevision === startRevision) return false;

    const unpacked = device.unpack(
      sessionContext.deviceData,
      path,
      startRevision + 1
    );
    count = Math.max(0, unpacked.length + count);
  }

  declarations.push({
    path: path,
    pathGet: 1,
    pathSet: count,
    attrGet: null,
    attrSet: null,
    defer: true
  });

  return true;
}