File: /home/f/r/e/frenchy/www/french-american.org/current/node_modules/dockerfile-ast/lib/instruction.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
/* --------------------------------------------------------------------------------------------
* Copyright (c) Remy Suen. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* ------------------------------------------------------------------------------------------ */
const vscode_languageserver_types_1 = require("vscode-languageserver-types");
const util_1 = require("./util");
const line_1 = require("./line");
const argument_1 = require("./argument");
const variable_1 = require("./variable");
const main_1 = require("./main");
class Instruction extends line_1.Line {
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) {
super(document, range);
this.dockerfile = dockerfile;
this.escapeChar = escapeChar;
this.instruction = instruction;
this.instructionRange = instructionRange;
}
toString() {
let value = this.getKeyword();
for (let arg of this.getArguments()) {
value += ' ';
value += arg.getValue();
}
return value;
}
getRangeContent(range) {
if (range === null) {
return null;
}
return this.document.getText().substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end));
}
getInstructionRange() {
return this.instructionRange;
}
getInstruction() {
return this.instruction;
}
getKeyword() {
return this.getInstruction().toUpperCase();
}
getArgumentsRange() {
let args = this.getArguments();
if (args.length === 0) {
return null;
}
return vscode_languageserver_types_1.Range.create(args[0].getRange().start, args[args.length - 1].getRange().end);
}
getArgumentsRanges() {
let args = this.getArguments();
if (args.length === 0) {
return [];
}
if (args[0].getRange().start.line === args[args.length - 1].getRange().end.line) {
return [vscode_languageserver_types_1.Range.create(args[0].getRange().start, args[args.length - 1].getRange().end)];
}
let ranges = [];
let end = -1;
let startPosition = args[0].getRange().start;
let range = this.getInstructionRange();
let extra = this.document.offsetAt(range.end) - this.document.offsetAt(range.start);
let content = this.getTextContent();
let fullArgs = content.substring(extra, this.document.offsetAt(args[args.length - 1].getRange().end) - this.document.offsetAt(range.start));
let offset = this.document.offsetAt(range.start) + extra;
let start = false;
let comment = false;
for (let i = 0; i < fullArgs.length; i++) {
let char = fullArgs.charAt(i);
if (char === this.escapeChar) {
let next = fullArgs.charAt(i + 1);
if (next === ' ' || next === '\t') {
whitespaceCheck: for (let j = i + 2; j < fullArgs.length; j++) {
switch (fullArgs.charAt(j)) {
case ' ':
case '\t':
continue;
case '\r':
j++;
case '\n':
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1)));
startPosition = null;
start = true;
comment = false;
i = j;
break whitespaceCheck;
default:
break whitespaceCheck;
}
}
}
else if (next === '\r') {
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1)));
startPosition = null;
start = true;
comment = false;
i += 2;
}
else if (next === '\n') {
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1)));
startPosition = null;
start = true;
comment = false;
i++;
}
else {
i++;
}
}
else if (util_1.Util.isNewline(char)) {
if (comment) {
if (startPosition) {
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end)));
}
startPosition = null;
start = true;
comment = false;
}
}
else {
if (!comment) {
if (startPosition === null) {
if (char === '#') {
comment = true;
}
let position = this.document.positionAt(offset + i);
if (position.character !== 0) {
startPosition = vscode_languageserver_types_1.Position.create(position.line, 0);
}
}
end = i;
}
}
}
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1)));
return ranges;
}
getRawArgumentsContent() {
let args = this.getArguments();
if (args.length === 0) {
return null;
}
return this.getRangeContent(vscode_languageserver_types_1.Range.create(args[0].getRange().start, args[args.length - 1].getRange().end));
}
getArgumentsContent() {
let args = this.getArguments();
if (args.length === 0) {
return null;
}
let content = "";
let ranges = this.getArgumentsRanges();
let documentText = this.document.getText();
for (let range of ranges) {
content += documentText.substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end));
}
return content;
}
getArguments() {
let args = [];
let range = this.getInstructionRange();
let extra = this.document.offsetAt(range.end) - this.document.offsetAt(range.start);
let content = this.getTextContent();
let fullArgs = content.substring(extra);
let offset = this.document.offsetAt(range.start) + extra;
let start = false;
let comment = false;
let found = -1;
// determines whether the parser has found a space or tab
// whitespace character that's a part of an escaped newline sequence
let escapedWhitespaceDetected = false;
// determines if the parser is currently in an escaped newline sequence
let escaping = false;
let escapeMarker = -1;
let escapedArg = "";
for (let i = 0; i < fullArgs.length; i++) {
let char = fullArgs.charAt(i);
if (util_1.Util.isWhitespace(char)) {
if (escaping) {
escapedWhitespaceDetected = true;
if (util_1.Util.isNewline(char)) {
// reached a newline, any previously
// detected whitespace should be ignored
escapedWhitespaceDetected = false;
if (comment) {
// reached a newline, no longer in a comment
comment = false;
}
}
continue;
}
else if (found !== -1) {
if (escapeMarker === -1) {
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + i))));
}
else {
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker))));
}
escapeMarker = -1;
escapedArg = "";
found = -1;
}
}
else if (char === this.escapeChar) {
let next = fullArgs.charAt(i + 1);
if (next === ' ' || next === '\t') {
whitespaceCheck: for (let j = i + 2; j < fullArgs.length; j++) {
let newlineCheck = fullArgs.charAt(j);
switch (newlineCheck) {
case ' ':
case '\t':
continue;
case '\r':
j++;
case '\n':
escaping = true;
start = true;
if (found !== -1) {
escapeMarker = i;
}
i = j;
break whitespaceCheck;
default:
escapeMarker = i;
if (found === -1) {
i = j - 1;
}
break whitespaceCheck;
}
}
}
else if (next === '\r') {
escaping = true;
start = true;
if (found !== -1) {
escapeMarker = i;
}
i += 2;
}
else if (next === '\n') {
escaping = true;
start = true;
if (found !== -1) {
escapeMarker = i;
}
i++;
}
else {
if (escapedWhitespaceDetected && escapeMarker !== -1) {
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker))));
escapedArg = "";
found = -1;
}
escapedWhitespaceDetected = false;
escaping = false;
if (next === '$') {
escapedArg = escapedArg + char + next;
}
else {
escapedArg = escapedArg + next;
}
if (found === -1) {
found = i;
}
i++;
}
}
else if (!comment) {
if (start && char === '#') {
start = false;
comment = true;
}
else {
if (escapedWhitespaceDetected && escapeMarker !== -1) {
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker))));
escapedArg = "";
found = -1;
}
escapedWhitespaceDetected = false;
escaping = false;
escapeMarker = -1;
escapedArg = escapedArg + char;
if (found === -1) {
found = i;
}
}
}
}
if (found !== -1) {
if (escapeMarker === -1) {
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + fullArgs.length))));
}
else {
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker))));
}
}
return args;
}
getExpandedArguments() {
let args = this.getArguments();
for (let i = 0; i < args.length; i++) {
const argRange = args[i].getRange();
let offset = this.document.offsetAt(argRange.start);
const variables = this.parseVariables(offset, args[i].getValue());
const swaps = [];
let requiresExpansion = false;
for (let variable of variables) {
const value = this.dockerfile.resolveVariable(variable.getName(), variable.getNameRange().start.line);
swaps.push(value);
requiresExpansion = requiresExpansion || value !== undefined;
}
if (requiresExpansion) {
let expanded = "";
for (let j = 0; j < swaps.length; j++) {
const variableRange = variables[j].getRange();
const start = this.document.offsetAt(variableRange.start);
const end = this.document.offsetAt(variableRange.end);
if (swaps[j]) {
// replace variable with its resolved value
expanded += this.document.getText().substring(offset, start);
expanded += swaps[j];
offset = end;
}
else {
expanded += this.document.getText().substring(offset, end);
offset = end;
}
}
const argEnd = this.document.offsetAt(argRange.end);
if (argEnd !== offset) {
// if the variable's range doesn't match the argument,
// append the remaining text
expanded += this.document.getText().substring(offset, argEnd);
}
args[i] = new argument_1.Argument(expanded, argRange);
}
}
return args;
}
getVariables() {
const variables = [];
const args = this.getArguments();
for (const arg of args) {
let range = arg.getRange();
let rawValue = this.document.getText().substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end));
const parsedVariables = this.parseVariables(this.document.offsetAt(arg.getRange().start), rawValue);
for (const parsedVariable of parsedVariables) {
variables.push(parsedVariable);
}
}
return variables;
}
parseVariables(offset, arg) {
let variables = [];
variableLoop: for (let i = 0; i < arg.length; i++) {
switch (arg.charAt(i)) {
case this.escapeChar:
if (arg.charAt(i + 1) === '$') {
i++;
}
break;
case '$':
if (arg.charAt(i + 1) === '{') {
let escapedString = "${";
let escapedName = "";
let nameEnd = -1;
let escapedSubstitutionParameter = "";
let substitutionStart = -1;
let substitutionEnd = -1;
let modifierRead = -1;
nameLoop: for (let j = i + 2; j < arg.length; j++) {
let char = arg.charAt(j);
switch (char) {
case this.escapeChar:
for (let k = j + 1; k < arg.length; k++) {
switch (arg.charAt(k)) {
case ' ':
case '\t':
case '\r':
// ignore whitespace
continue;
case '\n':
// escape this newline
j = k;
continue nameLoop;
}
}
break;
case '}':
escapedString += '}';
let modifier = null;
let modifierRange = null;
let substitutionParameter = modifierRead !== -1 ? escapedSubstitutionParameter : null;
let substitutionRange = null;
if (nameEnd === -1) {
nameEnd = j;
}
else if (nameEnd + 1 === j) {
modifier = "";
modifierRange = vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + nameEnd + 1), this.document.positionAt(offset + nameEnd + 1));
}
else {
if (substitutionStart === -1) {
// no substitution parameter found,
// but a modifier character existed,
// just offset the range by 1 from
// the modifier character
substitutionStart = modifierRead + 1;
substitutionEnd = modifierRead + 1;
}
else {
// offset one more from the last
// character found
substitutionEnd = substitutionEnd + 1;
}
modifier = arg.substring(modifierRead, modifierRead + 1);
modifierRange = vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + modifierRead), this.document.positionAt(offset + modifierRead + 1));
substitutionRange = vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + substitutionStart), this.document.positionAt(offset + substitutionEnd));
}
let start = this.document.positionAt(offset + i);
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 2), this.document.positionAt(offset + nameEnd)), vscode_languageserver_types_1.Range.create(start, this.document.positionAt(offset + j + 1)), modifier, modifierRange, substitutionParameter, substitutionRange, this.dockerfile.resolveVariable(escapedName, start.line) !== undefined, this.isBuildVariable(escapedName, start.line), escapedString));
i = j;
continue variableLoop;
case ':':
if (nameEnd === -1) {
nameEnd = j;
}
else if (modifierRead !== -1) {
if (substitutionStart === -1) {
substitutionStart = j;
substitutionEnd = j;
}
else {
substitutionEnd = j;
}
escapedSubstitutionParameter += ':';
}
else {
modifierRead = j;
}
escapedString += ':';
break;
case '\n':
case '\r':
case ' ':
case '\t':
break;
default:
if (nameEnd === -1) {
escapedName += char;
}
else if (modifierRead !== -1) {
if (substitutionStart === -1) {
substitutionStart = j;
substitutionEnd = j;
}
else {
substitutionEnd = j;
}
escapedSubstitutionParameter += char;
}
else {
modifierRead = j;
}
escapedString += char;
break;
}
}
// no } found, not a valid variable, stop processing
break variableLoop;
}
else if (util_1.Util.isWhitespace(arg.charAt(i + 1)) || i === arg.length - 1) {
// $ followed by whitespace or EOF, ignore this variable
continue;
}
else {
let escapedName = "";
nameLoop: for (let j = i + 1; j < arg.length; j++) {
let char = arg.charAt(j);
switch (char) {
case '\r':
case '\n':
case ' ':
case '\t':
continue;
case '$':
case '\'':
case '"':
let varStart = this.document.positionAt(offset + i);
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + j)), vscode_languageserver_types_1.Range.create(varStart, this.document.positionAt(offset + j)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, varStart.line) !== undefined, this.isBuildVariable(escapedName, varStart.line), '$' + escapedName));
i = j - 1;
continue variableLoop;
case this.escapeChar:
for (let k = j + 1; k < arg.length; k++) {
switch (arg.charAt(k)) {
case ' ':
case '\t':
case '\r':
// ignore whitespace
continue;
case '\n':
// escape this newline
j = k;
continue nameLoop;
}
}
// reached EOF after an escape character
let start = this.document.positionAt(offset + i);
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + j)), vscode_languageserver_types_1.Range.create(start, this.document.positionAt(offset + j)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, start.line) !== undefined, this.isBuildVariable(escapedName, start.line), '$' + escapedName));
break variableLoop;
}
if (char.match(/^[a-z0-9_]+$/i) === null) {
let varStart = this.document.positionAt(offset + i);
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + j)), vscode_languageserver_types_1.Range.create(varStart, this.document.positionAt(offset + j)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, varStart.line) !== undefined, this.isBuildVariable(escapedName, varStart.line), '$' + escapedName));
i = j - 1;
continue variableLoop;
}
escapedName += char;
}
let start = this.document.positionAt(offset + i);
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + arg.length)), vscode_languageserver_types_1.Range.create(start, this.document.positionAt(offset + arg.length)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, start.line) !== undefined, this.isBuildVariable(escapedName, start.line), '$' + escapedName));
}
break variableLoop;
}
}
return variables;
}
isBuildVariable(variable, line) {
if (this.getKeyword() === main_1.Keyword.FROM) {
for (const initialArg of this.dockerfile.getInitialARGs()) {
const arg = initialArg;
const property = arg.getProperty();
if (property && variable === property.getName()) {
return true;
}
}
return undefined;
}
let image = this.dockerfile.getContainingImage(vscode_languageserver_types_1.Position.create(line, 0));
let envs = image.getENVs();
for (let i = envs.length - 1; i >= 0; i--) {
if (envs[i].isBefore(line)) {
for (let property of envs[i].getProperties()) {
if (property.getName() === variable) {
return false;
}
}
}
}
let args = image.getARGs();
for (let i = args.length - 1; i >= 0; i--) {
if (args[i].isBefore(line)) {
let property = args[i].getProperty();
if (property && property.getName() === variable) {
return true;
}
}
}
return undefined;
}
}
exports.Instruction = Instruction;