gpgme/lang/js/src/Message.js

/* gpgme.js - Javascript integration for gpgme
 * Copyright (C) 2018 Bundesamt für Sicherheit in der Informationstechnik
 *
 * This file is part of GPGME.
 *
 * GPGME is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * GPGME 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, see <http://www.gnu.org/licenses/>.
 * SPDX-License-Identifier: LGPL-2.1+
 */
import { permittedOperations } from './permittedOperations'

export class GPGME_Message {
    //TODO getter

    constructor(){
    }

    /**
     * Defines the operation this message will have
     * @param {String} operation Mus be defined in permittedOperations
     *  TODO: move to constructor?
     */
    set operation (operation){
        if (!operation || typeof(operation) !== 'string'){
            throw('ERR_WRONG_PARAM');
        }
        if (operation in permittedOperations){
            if (!this._msg){
                this._msg = {};
            }
            this._msg.op = operation;
        } else {
            throw('ERR_NOT_IMPLEMENTED');
        }
    }

    /**
     * Sets a parameter for the message. Note that the operation has to be set
     * first, to be able to check if the parameter is permittted
     * @param {String} param Parameter to set
     * @param {any} value Value to set //TODO: Some type checking
     * @returns {Boolean} If the parameter was set successfully
     */
    setParameter(param,value){
        if (!param || typeof(param) !== 'string'){
            throw('ERR_WRONG_PARAM');
        }
        if (!this._msg || !this._msg.op){
            console.log('There is no operation specified yet. '+
                'The parameter cannot be set');
            return false;
        }
        let po = permittedOperations[this._msg.op];
        if (!po){
            throw('LAZY_PROGRAMMER');
            //TODO
            return false;
        }
        if (po.required.indexOf(param) >= 0 || po.optional.indexOf(param) >= 0){
            this._msg[param] = value;
            return true;
        }
        console.log('' + param + ' is invalid and could not be set');
        return false;
    }

    /**
     * Check if the message has the minimum requirements to be sent, according
     * to the definitions in permittedOperations
     * @returns {Boolean}
     */
    get isComplete(){
        if (!this._msg.op){
            return false;
        }
        let reqParams = permittedOperations[this._msg.op].required;
        for (let i=0; i < reqParams.length; i++){
            if (!reqParams[i] in this._msg){
                return false;
            }
        }
        return true;
    }

    /**
     * Returns the prepared message with parameters and completeness checked
     * @returns {Object|null} Object to be posted to gnupg, or null if
     * incomplete
     */
    get message(){
        if (this.isComplete === true){
            return this._msg;
        }
        else {
            return null;
        }

    }
}