X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=pakefile.php;h=30acead21eca50b4ae7fad1833f71a9c1caba827;hb=19b99735570521d8172f73124ade5997b9dca75d;hp=2ae9e357b4c66dd624f0b51cff860ecacac0f73b;hpb=0edbdbaa43d40da250ab8b9b548ce764a7ae884e;p=plcapi.git

diff --git a/pakefile.php b/pakefile.php
index 2ae9e35..30acead 100644
--- a/pakefile.php
+++ b/pakefile.php
@@ -3,20 +3,32 @@
  * Makefile for phpxmlrpc library.
  * To be used with the Pake tool: https://github.com/indeyets/pake/wiki
  *
- * @todo allow user to specify location for zip command
- * @todo allow user to specify release number and tag/branch to use
+ * @copyright (c) 2015 G. Giunta
+ *
+ * @todo !important allow user to specify location of docbook xslt instead of the one installed via composer
  */
 
 namespace PhpXmlRpc {
 
 class Builder
 {
-    protected static $buildDir = 'build/';
+    protected static $buildDir = 'build';
     protected static $libVersion;
-    protected static $sourceBranch = 'master';
+    protected static $tools = array(
+        'asciidoctor' => 'asciidoctor',
+        'fop' => 'fop',
+        'php' => 'php',
+        'zip' => 'zip',
+    );
+    protected static $options = array(
+        'repo' => 'https://github.com/gggeek/phpxmlrpc',
+        'branch' => 'php53'
+    );
 
     public static function libVersion()
     {
+        if (self::$libVersion == null)
+            throw new \Exception('Missing library version argument');
         return self::$libVersion;
     }
 
@@ -27,13 +39,13 @@ class Builder
 
     public static function workspaceDir()
     {
-        return self::buildDir().'workspace';
+        return self::buildDir().'/workspace';
     }
 
     /// most likely things will break if this one is moved outside of BuildDir
     public static function distDir()
     {
-        return self::buildDir().'xmlrpc-'.self::libVersion();
+        return self::buildDir().'/xmlrpc-'.self::libVersion();
     }
 
     /// these will be generated in BuildDir
@@ -45,21 +57,113 @@ class Builder
         );
     }
 
-    public static function sourceRepo()
+    public static function getOpts($args=array(), $cliOpts=array())
     {
-        return 'https://github.com/gggeek/phpxmlrpc';
+        if (count($args) > 0)
+        //    throw new \Exception('Missing library version argument');
+            self::$libVersion = $args[0];
+
+        foreach (self::$tools as $name => $binary) {
+            if (isset($cliOpts[$name])) {
+                self::$tools[$name] = $cliOpts[$name];
+            }
+        }
+
+        foreach (self::$options as $name => $value) {
+            if (isset($cliOpts[$name])) {
+                self::$options[$name] = $cliOpts[$name];
+            }
+        }
+
+        //pake_echo('---'.self::$libVersion.'---');
     }
 
-    /// @todo move git branch to be a named option?
-    public static function getOpts($args=array(), $cliOpts=array())
+    public static function tool($name)
     {
-        if (count($args) < 1)
-            throw new \Exception('Missing library version argument');
-        self::$libVersion = $args[0];
-        if (count($args) > 1)
-            self::$sourceBranch = $args[1];
+        return self::$tools[$name];
+    }
+
+    public static function option($name)
+    {
+        return self::$options[$name];
+    }
+
+    /**
+     * @param string $inFile
+     * @param string $xssFile
+     * @param string $outFileOrDir
+     * @throws \Exception
+     */
+    public static function applyXslt($inFile, $xssFile, $outFileOrDir)
+    {
+
+        if (!file_exists($inFile)) {
+            throw new \Exception("File $inFile cannot be found");
+        }
+        if (!file_exists($xssFile)) {
+            throw new \Exception("File $xssFile cannot be found");
+        }
+
+        // Load the XML source
+        $xml = new \DOMDocument();
+        $xml->load($inFile);
+        $xsl = new \DOMDocument();
+        $xsl->load($xssFile);
+
+        // Configure the transformer
+        $processor = new \XSLTProcessor();
+        if (version_compare(PHP_VERSION, '5.4', "<")) {
+            if (defined('XSL_SECPREF_WRITE_FILE')) {
+                ini_set("xsl.security_prefs", XSL_SECPREF_CREATE_DIRECTORY | XSL_SECPREF_WRITE_FILE);
+            }
+        } else {
+            // the php online docs only mention setSecurityPrefs, but somehow some installs have setSecurityPreferences...
+            if (method_exists('XSLTProcessor', 'setSecurityPrefs')) {
+                $processor->setSecurityPrefs(XSL_SECPREF_CREATE_DIRECTORY | XSL_SECPREF_WRITE_FILE);
+            } else {
+                $processor->setSecurityPreferences(XSL_SECPREF_CREATE_DIRECTORY | XSL_SECPREF_WRITE_FILE);
+            }
+        }
+        $processor->importStyleSheet($xsl); // attach the xsl rules
+
+        if (is_dir($outFileOrDir)) {
+            if (!$processor->setParameter('', 'base.dir', realpath($outFileOrDir))) {
+                echo "setting param base.dir KO\n";
+            }
+        }
+
+        $out = $processor->transformToXML($xml);
+
+        if (!is_dir($outFileOrDir)) {
+            file_put_contents($outFileOrDir, $out);
+        }
+    }
+
+    public static function highlightPhpInHtml($content)
+    {
+        $startTag = '<pre class="programlisting">';
+        $endTag = '</pre>';
 
-        pake_echo('---'.self::$libVersion.'---');
+        //$content = file_get_contents($inFile);
+        $last = 0;
+        $out = '';
+        while (($start = strpos($content, $startTag, $last)) !== false) {
+            $end = strpos($content, $endTag, $start);
+            $code = substr($content, $start + strlen($startTag), $end - $start - strlen($startTag));
+            if ($code[strlen($code) - 1] == "\n") {
+                $code = substr($code, 0, -1);
+            }
+
+            $code = str_replace(array('&gt;', '&lt;'), array('>', '<'), $code);
+            $code = highlight_string('<?php ' . $code, true);
+            $code = str_replace('<span style="color: #0000BB">&lt;?php&nbsp;<br />', '<span style="color: #0000BB">', $code);
+
+            $out = $out . substr($content, $last, $start + strlen($startTag) - $last) . $code . $endTag;
+            $last = $end + strlen($endTag);
+        }
+        $out .= substr($content, $last, strlen($content));
+
+        return $out;
     }
 }
 
@@ -71,10 +175,19 @@ use PhpXmlRpc\Builder;
 
 function run_default($task=null, $args=array(), $cliOpts=array())
 {
-    echo "Syntax: pake {\$pake-options} \$task \$lib-version [\$git-tag]\n";
+    echo "Syntax: pake {\$pake-options} \$task \$lib-version [\$git-tag] {\$task-options}\n";
     echo "\n";
     echo "  Run 'pake help' to list all pake options\n";
-    echo "  Run 'pake -T' to list all available tasks\n";
+    echo "  Run 'pake -T' to list available tasks\n";
+    echo "  Run 'pake -P' to list all available tasks (including hidden ones) and their dependencies\n";
+    echo "\n";
+    echo "  Task options:\n";
+    echo "      --repo=REPO      URL of the source repository to clone. Defaults to the github repo.\n";
+    echo "      --branch=BRANCH  The git branch to build from.\n";
+    echo "      --asciidoctor=ASCIIDOCTOR Location of the asciidoctor command-line tool\n";
+    echo "      --fop=FOP        Location of the apache fop command-line tool\n";
+    echo "      --php=PHP        Location of the php command-line interpreter\n";
+    echo "      --zip=ZIP        Location of the zip tool\n";
 }
 
 function run_getopts($task=null, $args=array(), $cliOpts=array())
@@ -89,13 +202,12 @@ function run_init($task=null, $args=array(), $cliOpts=array())
 {
     // download the current version into the workspace
     $targetDir = Builder::workspaceDir();
-    $targetBranch = 'php53';
 
     // check if workspace exists and is not already set to the correct repo
     if (is_dir($targetDir) && pakeGit::isRepository($targetDir)) {
         $repo = new pakeGit($targetDir);
         $remotes = $repo->remotes();
-        if (trim($remotes['origin']['fetch']) != Builder::sourceRepo()) {
+        if (trim($remotes['origin']['fetch']) != Builder::option('repo')) {
             throw new Exception("Directory '$targetDir' exists and is not linked to correct git repo");
         }
 
@@ -103,10 +215,10 @@ function run_init($task=null, $args=array(), $cliOpts=array())
         $repo->pull();
     } else {
         pake_mkdirs(dirname($targetDir));
-        $repo = pakeGit::clone_repository(Builder::sourceRepo(), Builder::workspaceDir());
+        $repo = pakeGit::clone_repository(Builder::option('repo'), Builder::workspaceDir());
     }
 
-    $repo->checkout($targetBranch);
+    $repo->checkout(Builder::option('branch'));
 }
 
 /**
@@ -118,12 +230,74 @@ function run_build($task=null, $args=array(), $cliOpts=array())
 {
 }
 
+function run_clean_doc()
+{
+    pake_remove_dir(Builder::workspaceDir().'/doc/api');
+    $finder = pakeFinder::type('file')->name('*.html');
+    pake_remove($finder, Builder::workspaceDir().'/doc/manual');
+    $finder = pakeFinder::type('file')->name('*.xml');
+    pake_remove($finder, Builder::workspaceDir().'/doc/manual');
+}
+
 /**
  * Generates documentation in all formats
  */
 function run_doc($task=null, $args=array(), $cliOpts=array())
 {
-    pake_echo('TBD...');
+    $docDir = Builder::workspaceDir().'/doc';
+
+    // API docs
+
+    // from phpdoc comments using phpdocumentor
+    $cmd = Builder::tool('php');
+    pake_sh("$cmd vendor/phpdocumentor/phpdocumentor/bin/phpdoc run -d ".Builder::workspaceDir().'/src'." -t ".Builder::workspaceDir().'/doc/api --title PHP-XMLRPC');
+
+    // User Manual
+
+    // html (single file) from asciidoc
+    $cmd = Builder::tool('asciidoctor');
+    pake_sh("$cmd -d book $docDir/manual/phpxmlrpc_manual.adoc");
+
+    // then docbook from asciidoc
+    /// @todo create phpxmlrpc_manual.xml with the good version number
+    /// @todo create phpxmlrpc_manual.xml with the date set to the one of last commit (or today?)
+    pake_sh("$cmd -d book  -b docbook $docDir/manual/phpxmlrpc_manual.adoc");
+
+    # Other tools for docbook...
+    #
+    # jade cmd yet to be rebuilt, starting from xml file and putting output in ./out dir, e.g.
+    #	jade -t xml -d custom.dsl xmlrpc_php.xml
+    #
+    # convertdoc command for xmlmind xxe editor
+    #	convertdoc docb.toHTML xmlrpc_php.xml -u out
+    #
+    # saxon + xerces xml parser + saxon extensions + xslthl: adds a little syntax highligting
+    # (bold and italics only, no color) for php source examples...
+    #	java \
+    #	-classpath c:\programmi\saxon\saxon.jar\;c:\programmi\saxon\xslthl.jar\;c:\programmi\xerces\xercesImpl.jar\;C:\htdocs\xmlrpc_cvs\docbook-xsl\extensions\saxon65.jar \
+    #	-Djavax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl \
+    #	-Djavax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl \
+    #	-Dxslthl.config=file:///c:/htdocs/xmlrpc_cvs/docbook-xsl/highlighting/xslthl-config.xml \
+    #	com.icl.saxon.StyleSheet -o xmlrpc_php.fo.xml xmlrpc_php.xml custom.fo.xsl use.extensions=1
+
+    // HTML (multiple files) from docbook - discontinued, as we use the nicer-looking html gotten from asciidoc
+    /*Builder::applyXslt($docDir.'/manual/phpxmlrpc_manual.xml', $docDir.'/build/custom.xsl', $docDir.'/manual');
+    // post process html files to highlight php code samples
+    foreach(pakeFinder::type('file')->name('*.html')->in($docDir.'/manual') as $file)
+    {
+        file_put_contents($file, Builder::highlightPhpInHtml(file_get_contents($file)));
+    }*/
+
+    // PDF file from docbook
+
+    // convert to fo and then to pdf using apache fop
+    Builder::applyXslt($docDir.'/manual/phpxmlrpc_manual.xml', $docDir.'/build/custom.fo.xsl', $docDir.'/manual/phpxmlrpc_manual.fo.xml');
+    $cmd = Builder::tool('fop');
+    pake_sh("$cmd $docDir/manual/phpxmlrpc_manual.fo.xml $docDir/manual/phpxmlrpc_manual.pdf");
+
+    // cleanup
+    unlink($docDir.'/manual/phpxmlrpc_manual.xml');
+    unlink($docDir.'/manual/phpxmlrpc_manual.fo.xml');
 }
 
 function run_clean_dist()
@@ -148,11 +322,12 @@ function run_dist($task=null, $args=array(), $cliOpts=array())
     // also: do we still need to run dos2unix?
 
     // create tarballs
+    $cwd = getcwd();
     chdir(dirname(Builder::distDir()));
     foreach(Builder::distFiles() as $distFile) {
         // php can not really create good zip files via phar: they are not compressed!
         if (substr($distFile, -4) == '.zip') {
-            $cmd = 'zip';
+            $cmd = Builder::tool('zip');
             $extra = '-9 -r';
             pake_sh("$cmd $distFile $extra ".basename(Builder::distDir()));
         }
@@ -164,10 +339,16 @@ function run_dist($task=null, $args=array(), $cliOpts=array())
             rename($pharFile, $distFile);
         }
     }
+    chdir($cwd);
+}
+
+function run_clean_workspace($task=null, $args=array(), $cliOpts=array())
+{
+    pake_remove_dir(Builder::workspaceDir());
 }
 
 /**
- * Cleans up the build directory
+ * Cleans up the whole build directory
  * @todo 'make clean' usually just removes the results of the build, distclean removes all but sources
  */
 function run_clean($task=null, $args=array(), $cliOpts=array())
@@ -180,10 +361,12 @@ pake_task( 'default' );
 // internal task: parse cli options
 pake_task('getopts');
 pake_task('init', 'getopts');
-pake_task('doc', 'getopts', 'init');
+pake_task('doc', 'getopts', 'init', 'clean-doc');
 pake_task('build', 'getopts', 'init', 'doc');
 pake_task('dist', 'getopts', 'init', 'build', 'clean-dist');
+pake_task('clean-doc', 'getopts');
 pake_task('clean-dist', 'getopts');
+pake_task('clean-workspace', 'getopts');
 pake_task('clean', 'getopts');
 
 }