Blades.js

/**
* @file Blades.js
* @overview 
* An alphabetical index of "blades" that can be used by our "jacknife" tool
* Each item is a step that can be triggered by a form as part of a workflow.
**/
function _initZZZBlades () {
    Blade({
    /** 
        * @name triggerActions.Approval Blade
        * @inner
        * {@link Blade}
        * @desc
        * Approval Blade allows us to set up an approval workflow. Approval workflows involve
        * creating two forms: a "request" form and then a nearly identical "approval" form.
        * The request form triggers our workflow to fill out the approval form automatically
        * and then send an email to the approver asking for them to "approve" it by filling in
        * the final approval fields.
        * @para
        * We then can trigger actions from the approval form.
        * @para
        * By combining approvals with other tools, you can turn any process into an approval
        * workflow. So, for example, an approval form could trigger a user to be created or
        * an event to be added to a calendar, etc.
        **/
        shortname:'Approval',
        name : "Create Approval Form",
        create : createApprovalFormFromUrl,
        params : [
	    {field:'createForm',
	     label:'Create Approval Form?',
	     type:BOOL,
	     val:true},
	    {field:'selectForm',
	     label:'Select Pre-Existing Approval Form?',
	     type:FORM,
	     val:undefined},
	    {field:'titleSuffix',
	     label:'Approval Form Title Suffix',
	     type:TEXT,
	     val:' Approval'},
	    {field:'destinationFolder','label':'Folder',
	     'type':FOLDER,
	     'val':undefined,},
	    //{field:'conditionalSubmit',
	    //type:BOOL,
	    //val:undefined,
	    //label:'Submit approval conditionally',
	    //mode:'value',},
	    //{field:'onlySubmitIf',
	    //type:FIELD,
	    //label:'Only Submit for Approval If',
	    //mode:'field',
	    //val:'True',},
	    {field:'convertFields','label':'Fields to Convert',
	     type:FIELDCONVERSION,
	     'val':[{'from':'FormUser','to':'Requester','type':FormApp.ItemType.TEXT},
		    {'from':'Timestamp','to':'Request Timestamp','type':FormApp.ItemType.TEXT},
		    {'from':'*#*FY16-MM-###','to':'PO Number','type':FormApp.ItemType.TEXT},
	           ],},
	    {field:'approvalHeader.title',label:'Header Title for Approval Form',
	     type:TEXT,val:'The above information was filled out by the requester. Use the section below to indicate your approval.'},
	    {field:'approvalHeader.helpText',
	     'label':'Approval Form Help Text',
	     'type':TEXT,
	     'val':'The above information was filled out by the requester. Use the section below to indicate your approval.'
	    },
	    {field:'newFields','label':'New Fields',
	     'type':FIELDLIST,
	     'val':[{'type':'textField','title':'Signature','helpText':'Write initials and date here to approve.'}]},
	    {field:'emailInformBody', label:'Body of email to requester.',
	     type:PARA,
	     val:'Your request has been submitted for approval to <<Approver>>. You have been issued an initial PO number <<PO Number>>, to be active upon approval.\n\nHere are the details of your request:'},
	    {field:'emailRequestBody',label:'Body of email to approver.',
	     type:PARA,
	     val:'We have received a request and need your approval. <a href="<<link>>">Click here</a> to approve.'},
        ], // end params

        trigger: function (event, masterSheet, actionRow, actionResults) {
	    Logger.log('!!! APPROVAL TRIGGER !!!! => '+event+'-'+masterSheet+'-'+actionRow);
	    var responses = getResponseItems(event.response)
	    Logger.log('Get actionRow'+JSON.stringify(actionRow));
	    console.log('APPROVAL Looking at event %s',event.response.getId(),event.response,actionRow);
	    Logger.log('Get actionRow[Config1]'+JSON.stringify(actionRow.Config1));
	    // configuration set up
	    var f2f = lookupFields(actionRow.Config1.table,responses);
	    var templateSettings = actionRow['Config2'].table
	    var config = lookupFields(templateSettings,responses);
	    if (config.conditionalSubmit) {
	        //console.log('Checking on conditional submit');
	        //console.log('onlySubmitIf: %s',config.onlySubmitIf);
	        //console.log('onlySubmitIf: %s',checkBool(config.onlySubmitIf));
	        //console.log('onlySubmitIf setting: %s',templateSettings.onlySubmitIf);
	        if (!checkBool(config.onlySubmitIf)) {
		    logNormal('Conditionally not submitting for approval: %s',config);
		    return
	        }
	        else {
		    logNormal('Checked conditon: we are submitting! %s',config);
	        }
	    }
	    else {
	        console.log('We do not have to check conditionalSubmit: not in %s',config)
	    }
	    var logConf = actionRow['Config3'].table
	    checkForSelfApproval(config);
	    f2f.Approver = config.Approver;
	    logConf.Approver = config.Approver;
	    // end configuration setup
	    Logger.log('Got f2f'+JSON.stringify(f2f));
	    if (! actionRow['Config1'].table) {
	        Logger.log('Did not find approval form to master :(');
	        Logger.log('actionRow: '+JSON.stringify(actionRow));
	        return 0
	    }
	    checkParam(actionRow.Config1,'Approval Form ID',FORMID);
	    var targetForm = FormApp.openById(actionRow['Config1'].table['Approval Form ID'])
	    lookupMagic(f2f,responses,targetForm);
	    //emailError ("Working with target f2f:"+JSON.stringify(f2f), 'no real error') 
	    var approvalRespObj = preFillApprovalForm({'targetForm':targetForm,
						       'responseItems':responses,
						       'field2field':f2f})
	    var editUrl = approvalRespObj.edit_url
	    //if (actionRow['Config2'].table && actionRow['Config3'].table) {
	    //var lookupSettings = actionRow['Config3'].table
	    //responses['link'] = editUrl;
	    // DEBUG
	    //emailError('Checked for self-approval: '+JSON.stringify(config),'no error');
	    // END DEBUG
	    config.link = editUrl;
	    // Update with fields from lookup magic...
	    for (var key in f2f) {
	        if (! config[key]) {
		    Logger.log('Setting config[%s] from f2f[%s]',config[key],f2f[key]);
		    config[key] = f2f[key];
	        }
	        else {
		    Logger.log('Not overriding[%s] with f2f[%s]',config[key],f2f[key]);
	        }
	    }
	    for (var key in responses) {
	        config[key] = responses[key];
	    }
	    // send email with request
	    if (config.Approver) {
	        sendEmailFromTemplate(config.Approver,config.RequestSubject,config.RequestBody,
				      config,true);
	    }
	    else {
	        console.info('Odd: approval setup with no email to an approver.');
	    }
	    if (config.InformSubmitter) {
	        // send email informing user of response thingy...
	        sendEmailFromTemplate(responses.FormUser, config.InformSubject, config.InformBody,
				      config, true
				     ); 
	    }
	    logEvent(
	        logConf,
	        event,
	        actionResults,
	        {'ApprovalResponseId':approvalRespObj.response.getId(),
	         'ApprovalURL':editUrl,
	         'OriginalResponseId':event.response.getId(),
	         'OriginalURL':event.response.getEditResponseUrl()}
	    );
	    return config;
        }});
    /** 
        * @name Calendar Blade
        * @desc
        * {@link Blade}
        * Calendar Blade shares a calendar.
        **/
    Blade({
        shortname:'Calendar',
        name:'Share Calendar',
        params : [],
        trigger:function (event, masterSheet, actionRow) {
	    Logger.log('!!! CALENDAR TRIGGER !!!! => '+event+'-'+masterSheet+'-'+actionRow);
	    responses = getResponseItems(event.response);
	    var calConfig = actionRow['Config1'].table;
	    checkParam(actionRow.Config1,'Username')
	    checkParam(actionRow.Config1,'EmailSubject')
	    checkParam(actionRow.Config1,'EmailBody')
	    checkParam(actionRow.Config1,'CalendarsRead')
	    checkParam(actionRow.Config1,'CalendarsWrite')
	    //var informConfig = actionRow['Config2'].table;
	    //var emailConfig = actionRow['Config3'].table;
	    var calendarsAdded = addUserToCalendarFromForm(responses, calConfig)//, informConfig, emailConfig);
	    Logger.log('Added calendars: '+JSON.stringify(calendarsAdded));
	    return calendarsAdded
        }})

    /** 
        * @name CalendarEvent Blade
        * @desc
        * {@link Blade}
        * CalendarEvent Blade creates an event on a calendar.
        **/

    Blade({
        shortname:'CalendarEvent',
        name : 'Create Event',
        params : [],
        create : function (formUrl, params) {
	    var form = FormApp.openByUrl(formUrl)
	    return createCalEventTrigger(form, params);
        },
        params : [
	    {field:'CalendarID',label:'Calendar ID',val:'',type:TEXT,},
	    {field:'Title',label:'Title',val:'',type:FIELD,mode:'field'},
	    {field:'Date',label:'Date',val:'',type:FIELD,mode:'field'},
	    {field:'Location',label:'Location',val:'',type:FIELD,mode:'field'},
	    {field:'Description',label:'Description',val:'',type:PARA,mode:'field'},
	    {field:'onlyAddIf',label:'Only Add If Value is True (not No or False or Empty):',val:'',type:FIELD,mode:'field'},
        ],
        trigger:function (event, masterSheet, actionRow, actionResults) {
	    responses = getResponseItems(event.response);
	    var ceConfig = actionRow['Config1'].table;
	    checkParam(actionRow.Config1,'Title',IS_DEFINED)
	    try {
	        checkParam(actionRow.Config1,'Date',IS_DEFINED)
	    }
	    catch (e) {
	        console.log('Date not defined: checking time');
	        checkParam(actionRow.Config1,'startTime')
	        checkParam(actionRow.Config1,'endTime')
	    }
	    return addCalendarEventFromForm(responses,ceConfig);
        }
    })

    /** 
        * @name Email Blade
        * @desc
        * {@link Blade}
        * Email Blade sends a form email from a template.
        **/

    Blade({
        shortname:'Email',
        name:'Send Email',
        create:function (formUrl, params) {
	    console.log('Got URL: %s',formUrl);
	    form = FormApp.openByUrl(formUrl);
	    createEmailTrigger(form, params);
        }, // end email callback
        params :[{field:'Subject',val:'Form Received','type':FIELD,'label':'Subject',mode:'value'},
	         {field:'Body',val:'Your request has been responded to by <<FormUser>>.','type':PARA,'label':'Body'},
	         {field:'To',val:'',type:FIELD,label:'To',mode:'field'},
	         {field:'onlyEmailIf',val:'',type:FIELD,label:'Only Email If Value is True (not No or False or empty)',mode:'field'}
	        ],
        trigger : function (event, masterSheet, actionRow, actionResults) {
	    Logger.log('!!! EMAIL TRIGGER !!!! => '+event+'-'+masterSheet+'-'+actionRow);
	    var responses = getResponseItems(event.response,actionResults);
	    var settings = actionRow['Config1'].table    
	    checkParam(actionRow.Config1,'To');
	    checkParam(actionRow.Config1,'Body',IS_DEFINED);
	    checkParam(actionRow.Config1,'Subject',IS_DEFINED);
	    return sendFormResultEmail(
	        responses,
	        settings
	        //templateSettings,
	        //lookupSettings
	    );
        }}) // end Email

    /** 
        * @name Folder Blade
        * @desc
        * {@link Blade}
        * Folder Blade shares a Drive folder.
        **/
    Blade({shortname:'Folder',
           name:'Share Folder',
           trigger:function (event, masterSheet, actionRow) {
	       Logger.log('!!! FOLDER TRIGGER !!!! => '+event+'-'+masterSheet+'-'+actionRow);
	       responses = getResponseItems(event.response);
	       var config = actionRow['Config1'].table;
	       checkParam(actionRow.Config1,'Username')
	       checkParam(actionRow.Config1,'FoldersRead')
	       checkParam(actionRow.Config1,'FoldersWrite')
	       return addUserToFoldersFromForm(responses,config);
           },
           create : function (form,params) {
	       createDriveFormAndConfig(params.folders,form)
           },
           params:[
	       {field:'Username',label:'Username',val:'%Username',type:FIELD},
	       {field:'folders',label:'Folder List',type:FOLDERLIST},
	       {field:'EmailSubject',val:defaultDriveSubjectTemplate,type:PARA},
	       {field:'EmailBody',val:defaultDriveBodyTemplate,type:PARA},
	       {field:'InformFormUser',val:1,type:BOOL},
           ],
          }) // end Folder


    /** 
        * @name Group Blade
        * @desc
        * {@link Blade}
        * Group Blade adds a user to groups.
        **/
    Blade({
        shortname:'Group',
        name:'Add to groups',
        params : [
	    {field:'username',label:'User to be added to group',type:FIELD,val:'%Username'},
	    {field:'groups','label':'Groups to add user to','type':FIELD,val:'%Add to Google Groups'},
	    {field:'NeedsAuthorization',label:'Needs Authorization',type:BOOL,val:true},
	    {field:'Authorize',label:'Authorize Users',type:FIELD,val:'@FormUser>>AuthorizedUser'},
        ],
        trigger:function (event, masterSheet, actionRow) {
	    Logger.log('!!! GROUP TRIGGER !!!! => '+event+'-'+masterSheet+'-'+actionRow);
	    responses = getResponseItems(event.response);
	    var groupConfig = actionRow['Config1'].table;
	    checkParam(actionRow.Config1,'username',IS_DEFINED)
	    checkParam(actionRow.Config1,'groups',IS_DEFINED)
	    return addToGroupFromForm(responses,groupConfig);
        }
    })

    /** 
        * @name Log Blade
        * @desc
        * {@link Blade}
        * Log Blade logs form data to a spreadsheet
        **/
    Blade({
        shortname:'Log',
        name:'Log to File',
        params : [{field:'SheetId',type:TEXT,label:'ID of Spreadsheet Tab',help:'0 for main one'},
	          {field:'SpreadsheetId',type:SPREADSHEET,label:'ID of Spreadsheet'},
	         ],
        trigger:function (event, masterSheet, actionRow, actionResults) {
	    checkParam(actionRow.Config1,'SpreadsheetId',SPREADSHEETID);
	    checkParam(actionRow.Config1,'SheetId');
	    return logEvent(actionRow['Config1'].table,event,actionResults);
        }})

    /** 
        * @name NewUser Blade
        * @desc
        * {@link Blade}
        * NewUser Blade creates a new user.
        **/
    Blade({
        shortname: 'NewUser',
        params : [],
        trigger : function (event, masterSheet, actionRow) {
	    var responses = getResponseItems(event.response);
 	    var usernameSettings = actionRow['Config1'].table;
	    ['first','last','informList','username','emailSubject','emailTemplate','requirePasswordReset'].forEach(
	        function (p) {
		    checkParam(actionRow.Config1,p);
	        })
 	    return createAccountFromForm(
	        //results, fieldSettings, informSettings, emailTemplateSettings
	        responses, 
 	        usernameSettings
 	        //informSettings,
	        //  emailSettings
 	    );
        },
    })
}