From issues-return-25133-apmail-cordova-issues-archive=cordova.apache.org@cordova.apache.org  Thu May  1 16:07:16 2014
Return-Path: <issues-return-25133-apmail-cordova-issues-archive=cordova.apache.org@cordova.apache.org>
X-Original-To: apmail-cordova-issues-archive@minotaur.apache.org
Delivered-To: apmail-cordova-issues-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 6088B102A2
	for <apmail-cordova-issues-archive@minotaur.apache.org>; Thu,  1 May 2014 16:07:16 +0000 (UTC)
Received: (qmail 79974 invoked by uid 500); 1 May 2014 16:07:15 -0000
Delivered-To: apmail-cordova-issues-archive@cordova.apache.org
Received: (qmail 79946 invoked by uid 500); 1 May 2014 16:07:15 -0000
Mailing-List: contact issues-help@cordova.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:issues-help@cordova.apache.org>
List-Unsubscribe: <mailto:issues-unsubscribe@cordova.apache.org>
List-Post: <mailto:issues@cordova.apache.org>
List-Id: <issues.cordova.apache.org>
Reply-To: dev@cordova.apache.org
Delivered-To: mailing list issues@cordova.apache.org
Received: (qmail 79934 invoked by uid 99); 1 May 2014 16:07:15 -0000
Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 May 2014 16:07:15 +0000
Date: Thu, 1 May 2014 16:07:15 +0000 (UTC)
From: "ASF GitHub Bot (JIRA)" <jira@apache.org>
To: issues@cordova.apache.org
Message-ID: <JIRA.12709596.1398105082896.213922.1398960435127@arcas>
In-Reply-To: <JIRA.12709596.1398105082896@arcas>
References: <JIRA.12709596.1398105082896@arcas>
Subject: [jira] [Commented] (CB-6481) adds plugin level hooks support
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


    [ https://issues.apache.org/jira/browse/CB-6481?page=3Dcom.atlassian.ji=
ra.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D1398671=
0#comment-13986710 ]=20

ASF GitHub Bot commented on CB-6481:
------------------------------------

Github user agrieve commented on a diff in the pull request:

    https://github.com/apache/cordova-plugman/pull/74#discussion_r12193231
 =20
    --- Diff: src/util/hooks.js ---
    @@ -0,0 +1,124 @@
    +/*
    + * Copyright (c) Microsoft Open Technologies, Inc. =20
    + *=20
    + * Licensed under the Apache License, Version 2.0 (the "License");=20
    + * you may not use this file except in compliance with the License.=20
    + * You may obtain a copy of the License at=20
    + *=20
    + *     http://www.apache.org/licenses/LICENSE-2.0=20
    + *=20
    + * Unless required by applicable law or agreed to in writing,
    + * software distributed under the License is distributed on an
    + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    + * KIND, either express or implied.  See the License for the
    + * specific language governing permissions and limitations
    + * under the License.
    + */
    +
    +var path =3D require('path'),
    +    fs   =3D require('fs'),
    +    child_process =3D require('child_process'),
    +    Q =3D require('q'),
    +    events =3D require('../events'),
    +    os =3D require('os'),
    +    isWindows =3D (os.platform().substr(0,3) =3D=3D=3D 'win');
    +
    +/**
    + * Implements functionality to run plugin level hooks.=20
    + * Hooks are defined in plugin config file as <script> elements.
    + */
    +module.exports =3D {
    +    /**
    +     * Fires specific plugin hook: 'preinstall', 'afterinstall', 'unin=
stall', etc.
    +     * Async. Returns promise.
    +     */
    +    fire : function(type, plugin_id, pluginElement, platform, project_=
dir, plugin_dir) {
    +        // args check
    +        if (!type) {
    +            throw Error('hook type is not specified');
    +        }
    +
    +        events.emit('debug', 'Executing "' + type + '"  hook for "' + =
plugin_id + '" on ' + platform + '.');
    +       =20
    +        var scriptTypes =3D getScriptTypesForHook(type);
    +        if (scriptTypes =3D=3D null) {
    +            throw Error('unknown plugin hook type: "' + type + '"' );
    +        }
    +
    +        var scriptFilesToRun =3D getScriptFiles(pluginElement, scriptT=
ypes, platform);
    +            context =3D {
    +                platform: platform,
    +                projectDir: project_dir,
    +                pluginDir: plugin_dir,
    +                cmdLine: process.argv.join(' '),
    +                pluginId: plugin_id
    +            };
    +
    +        return runScripts(scriptFilesToRun, context);
    +    }
    +};
    +
    +/**
    + * Returns all script types represented corresponding hook event.
    + * Allows to use multiple script types for the same hook event (usage =
simplicity),
    + * For example:=20
    + * <script type=3D'install' .. /> or <script type=3D'postinstall' .. /=
> could be used=20
    + * to define 'afterinstall' hook.
    + */
    +function getScriptTypesForHook(hookType) {
    +    var knownTypes =3D {
    +        beforeinstall: ['beforeinstall', 'preinstall'],
    +        afterinstall: ['install', 'afterinstall', 'postinstall'],
    +        uninstall: ['uninstall']
    +    }
    +
    +     return knownTypes[hookType.toLowerCase()];
    +}
    +
    +/**
    + * Gets all scripts from the plugin xml with the specified types.
    + */
    +function getScriptFiles(pluginElement, scriptTypes, platform) {
    +    var scriptFiles=3D [],
    +        scriptElements =3D  pluginElement.findall('./script').concat(
    +            pluginElement.findall('./platform[@name=3D"' + platform + =
'"]/script'));
    +
    +    var pendingScripts =3D [];
    +
    +    scriptElements.forEach(function(script){
    +        if (script.attrib.type && scriptTypes.indexOf(script.attrib.ty=
pe.toLowerCase()) > -1 && script.attrib.src) {
    +            scriptFiles.push(script.attrib.src);
    +        }
    +    });
    +    return scriptFiles;
    +}
    +
    +/**
    + * Async runs the script files.
    + */
    +function runScripts(scripts, context) {
    +    var pendingScripts =3D [];
    +
    +    scripts.forEach(function(script){
    +        pendingScripts.push(runScriptFile(script, context));
    +    });
    +
    +    return Q.all(pendingScripts);
    +};
    +
    +/**
    + * Async runs single script file.
    + */
    +function runScriptFile(scriptPath, context) {
    +
    +    scriptPath =3D path.join(context.pluginDir, scriptPath);
    +
    +    if(!fs.existsSync(scriptPath)) {
    +        events.emit('warn', "Script file does't exist and will be skip=
ped: " + scriptPath);
    +        return Q();
    +    }
    +    var scriptFn =3D require(scriptPath);
    +
    +    // if hook is async it can return promise instance and we will han=
dle it
    +    return Q(new scriptFn(context));
    --- End diff --
   =20
    why "new" it?


> adds plugin level hooks support
> -------------------------------
>
>                 Key: CB-6481
>                 URL: https://issues.apache.org/jira/browse/CB-6481
>             Project: Apache Cordova
>          Issue Type: New Feature
>          Components: CLI, Plugman
>            Reporter: Sergey Grebnov
>            Assignee: Sergey Grebnov
>
> As per "Proposal: hooks support for plugins" dev mail thread discussion
> Hi, I have an idea how we can add more flexibility to plugin developers.
> Note, right now we have Application Developers =E2=80=93 someone who use =
Cordova for developing applications and Plugin Developers =E2=80=93 someone=
 who creates plugins so that Application Developers can use them. For Appli=
cation Developers we expose  hooks so that they can customize their build/p=
ackage/etc process. I want us to provide similar sort of flexibility to Plu=
gin Developers so that they can go beyond of <source/>, <framework/>  tags =
and get mechanism to add custom installation,  build logic required by a pl=
ugin. Example usage will include: downloading/compiling additional binaries=
, marking source file to be copied to output dir, changing target build pla=
tform,  etc. At present time the steps described could be only achieved by =
hooks manually added by Application Developer, but the right way is to allo=
w Plugin Developer to expose this as part of plugin definition.
> Example configuration could look like
> ```
> <script type=3D"postinstall" src=3D"scripts/postinstall.js" />
> <script type=3D"preinstall" src=3D"scripts/preinstall.js" />
> <script type=3D"install" src=3D"scripts/install.js" />
> ```
> beforeinstall/preinstall =E2=80=93 run before plugin is installed
> install/postinstall/afterinstall =E2=80=93 run after plugin is installed
> uninstall =E2=80=93 run after plugin is uninstalled



--
This message was sent by Atlassian JIRA
(v6.2#6252)