Templater.php

<?php

namespace RedcapConHack\Templater;

class Templater extends \ExternalModules\AbstractExternalModule
{

    const DEFAULT_FRAMEWORK_VERSION = 10;
    const DEFAULT_MODULE_VERSION = "0.0.0";

    function generateTemplateFromPost($twig)
    {
        # build $data array from $_POST array so Twig can render our files
        $hookInfo = self::getHookInfo();
        $data = [
            'moduleName' => $_POST['moduleName'],
            'className' => $_POST['className'],
            'everyPageHooks' => $_POST['everyPageHooks'],
            'namespace' => $_POST['namespace'],
            'description' => $_POST['moduleDescription'],
            'dirName' => $_POST['dirName'],
            'OrgName' => $_POST['orgName'],
            'frameworkVersion' => $_POST['frameworkVersion'] ?: $this::DEFAULT_FRAMEWORK_VERSION,
            'authors' => [],
            'controlCenterLinks' => [],
            'crons' => [],
            'hooks' => [],
            'projectLinks' => [],
            'includeGitInit' => isset($_POST['includeGitInit']) && $_POST['includeGitInit'] == 'on',
            'gitOrg' => $_POST['gitOrg'],
            'gitRepo' => $_POST['gitRepo'],
            'includeGitIgnore' => isset($_POST['includeGitIgnore']) && $_POST['includeGitIgnore'] == 'on',
            'includeEditorConfig' => isset($_POST['includeEditorConfig']) && $_POST['includeEditorConfig'] == 'on',
            'Year' => date('Y')
        ];

        if (strpos($data['namespace'], $data['className']) === false) {
            $data['namespace'] = $data['namespace'] . "\\" . $data['className'];
        }

        $data['initialVersion'] = empty($_POST['moduleInitVersion']) ? self::DEFAULT_MODULE_VERSION : $_POST['moduleInitVersion'];

        // determine directory name via given class name
        if (empty($_POST['dirName'])) {
            preg_match_all('/([A-Z]*[a-z]*)/', $data['className'], $matches);
            array_pop($matches[0]);
            $data['dirName'] = join('_', array_map('strtolower', $matches[0])) . '_v' . $data['initialVersion'];
        }

        # authors
        $done = false;
        $i = 1;
        while (!$done) {
            if (isset($_POST["authorsName$i"])) {
                $data['authors'][$i] = [
                    'name' => $_POST["authorsName$i"],
                    'email' => $_POST["authorsEmail$i"],
                    'org' => $_POST["authorsOrg$i"]
                ];
            } else {
                $done = true;
            }
            $i++;
        }

        # hooks
        foreach (array_merge($hookInfo['redcap'], $hookInfo['exmod']) as $hook) {
            if (isset($_POST[$hook['name']])) {
                array_push($data['hooks'], $hook);
            }
        }

        # links
        $done = false;
        $i = 1;
        while (!$done) {
            if (isset($_POST["linksName$i"])) {
                # add link to twig $data variable
                $link = [
                    'name' => $_POST["linksName$i"],
                    'url' => $_POST["linksUrl$i"],
                    'icon' => $_POST["linksIcon$i"]
                ];
                if (isset($_POST["linksNOAUTH$i"])) {
                    $link['NOAUTH'] = true;
                }
                if (isset($_POST["linksControlCenterCheckbox$i"])) {
                    array_push($data['controlCenterLinks'], $link);
                }
                if (isset($_POST["linksProjectCheckbox$i"])) {
                    array_push($data['projectLinks'], $link);
                }
            } else {
                $done = true;
            }
            $i++;
        }

        # crons
        $done = false;
        $i = 1;
        while (!$done) {
            if (isset($_POST["cronsName$i"]) && ($_POST["cronsName$i"] != "")) {
                $data['crons'][$i] = [
                    'name' => $_POST["cronsName$i"],
                    'desc' => $_POST["cronsDescription$i"],
                    'method' => $_POST["cronsMethod$i"],
                    'freq' => $_POST["cronsFrequency$i"],
                    'max' => $_POST["cronsMaxRunTime$i"]
                ];
            } else {
                $done = true;
            }
            $i++;
        }

        // // uncomment to test print a page to browser
        // header('content-type: text/plain');
        // // print_r($data);
        // echo $twig->render('class.twig', $data);
        // exit;

        # render necessary files
        $classFile = $twig->render('class.twig', $data);
        $configFile = $twig->render('config.twig', $data);
        $readmeFile = $twig->render('README.twig', $data);

        # create zip file, open it, add files, close zip, and send
        $zip = new \ZipArchive();
        $file = tempnam(EDOC_PATH, "");
        $zip->open($file, \ZipArchive::CREATE);
        $zip->addFromString($data['className'] . '.php', $classFile);
        $zip->addFromString('config.json', $configFile);
        $zip->addFromString('README.md', $readmeFile);

        # add method files for links and crons? (e.g., generate_template.php)
        foreach ($data["projectLinks"] as $thisLink) {
            $zip->addFromString($thisLink["url"], "<?php\nnamespace " . $data["namespace"] . ";\n/** @var \$module " . $data["className"] . " */\n");
        }

        foreach ($data["controlCenterLinks"] as $thisLink) {
            $zip->addFromString($thisLink["url"], "<?php\nnamespace " . $data["namespace"] . ";\n/** @var \$module " . $data["className"] . " */\n");
        }

        # add LICENSE?
        if (isset($_POST['includeLicense']) and isset($_POST['licenseText'])) {
            $licenseText = htmlspecialchars($_POST['licenseText'], ENT_QUOTES);
            $twigTemplate = twig_template_from_string($twig, $licenseText);
            $license = $twigTemplate->render($data);
            $zip->addFromString('LICENSE', $license);
        }

        # git init
        if ($data['includeGitInit']) {
            $gitInitFile = $twig->render('gitInit.twig', $data);
            $zip->addFromString('gitInit.sh', $gitInitFile);
        }

        # add .gitignore
        if ($data['includeGitIgnore']) {
            $gitIgnoreFile = $twig->render('gitIgnore.twig', $data);
            $zip->addFromString('.gitignore', $gitIgnoreFile);
        }

        # add editorconfig
        if ($data['includeEditorConfig']) {
            $editorConfigFile = $twig->render('editorConfig.twig', $data);
            $zip->addFromString('.editorConfig', $editorConfigFile);
        }

        $zip->close();
        $zipFileName = $data['dirName'] . '.zip';
        header("Content-disposition: attachment; filename=$zipFileName");
        header('Content-type: application/zip');
        header('Content-transfer-encoding: binary');
        header("Content-length: " . filesize($file));
        header("Pragma: no-cache");
        header("Expires: 0");
        readfile($file);
        unlink($file);
    }

    public static function getHookInfo()
    {
        # Get array of Hook methods and their attributes
        $temp = \PluginDocs::getPluginMethods(\PluginDocs::HOOKS_CLASS);
        $hooks = [
            "redcap" => [],
            "exmod" => [
                "1" => [
                    "name" => "redcap_module_system_enable",
                    "description" => "Triggered when a module gets enabled on Control Center.",
                    "function" => "void <b>redcap_module_system_enable</b> ( <b>\$version</b> )"
                ],
                "2" => [
                    "name" => "redcap_module_system_disable",
                    "description" => "Triggered when a module gets disabled on Control Center.",
                    "function" => "void <b>redcap_module_system_disable</b> ( <b>\$version</b> )"
                ],
                "3" => [
                    "name" => "redcap_module_system_change_version",
                    "description" => "Triggered when a module version is changed.",
                    "function" => "void <b>redcap_module_system_change_version</b> ( <b>\$version, \$old_version</b> )"
                ],
                "4" => [
                    "name" => "redcap_module_project_enable",
                    "description" => "Triggered when a module gets enabled on a specific project.",
                    "function" => "void <b>redcap_module_project_enable</b> ( <b>\$version, \$project_id</b> )"
                ],
                "5" => [
                    "name" => "redcap_module_project_disable",
                    "description" => "Triggered when a module gets disabled on a specific project.",
                    "function" => "void <b>redcap_module_project_disable</b> ( <b>\$version, \$project_id</b> )"
                ],
                "6" => [
                    "name" => "redcap_module_configure_button_display",
                    "description" => "Triggered when each enabled module defined is rendered. Return <code>null</code> if you don't want to display the Configure button and <code>true</code> to display.",
                    "function" => "void <b>redcap_module_configure_button_display</b> ( )"
                ],
                "7" => [
                    "name" => "redcap_module_link_check_display",
                    "description" => "Triggered when each link defined in config.json is rendered. Override this method and return <code>null</code> if you don't want to display the link, or modify and return the <code>\$link</code> parameter as desired. This method also controls whether pages will load if users access their URLs directly.",
                    "function" => "void <b>redcap_module_link_check_display</b> ( <b>\$project_id, \$link</b> )"
                ],
                "8" => [
                    "name" => "redcap_module_save_configuration",
                    "description" => "Triggered after a module configuration is saved.",
                    "function" => "void <b>redcap_module_save_configuration</b> ( <b>\$project_id</b> )"
                ]
            ]
        ];

        $i = 1;
        foreach ($temp as $name => $info) {
            $hooks['redcap']["$i"] = [
                "name" => $name,
                "description" => $info['SUMMARY'],
                "function" => $info['DESCRIPTION']
            ];
            $i++;
        }

        $signatureFixes = array(
            "void" => ""
        );

        foreach ($hooks as $setName => $set) {
            foreach ($set as $hookName => $hook) {
                preg_match('/\(.*\)/', $hook['function'], $matches);
                $args = strip_tags($matches[0]);
                $args = str_replace(array_keys($signatureFixes), array_values($signatureFixes), $args);

                ## int varName = NULL is invalid syntax, so remove
                $args = preg_replace('/int (\$[a-zA-Z0-9\_]+) \= NULL/', "\\1", $args);
                $args = preg_replace('/int (\$[a-zA-Z0-9\_]+) \= 1/', "\\1", $args);
                $args = preg_replace('/string (\$[a-zA-Z0-9\_]+) \= NULL/', "\\1", $args);
                $args = preg_replace('/array (\$[a-zA-Z0-9\_]+) \= NULL/', "\\1", $args);

                $hooks[$setName][$hookName]['args'] = $args;
            }
        }

        return $hooks;
    }
}